ChadSmiley Blog Things about family, life, coding, and more

'Domino_Extended: 
 
Option Public
Option Declare
Dim System As Variant
 
'/**
' * A basic class to extend the NotesDocument class to reduce
' * code and improve error checking
' * 
' *	@author	Tim Tripcony				http://www.timtripcony.com
' *	@author	Chad Schelfhout		http://www.chadsmiley.com/
' * 	
' *	@version	1.0	Created by Tim
' *	@version	1.1	Split intialization, each object is initalized only when it is needed
' * @version	1.2	Converted NotesDocument to NotesDocumentExtended
' * @version	1.3	Converted properties to Function so it is easily ported to Java
' */
Private Class NotesSystem
	'Used to determine if each object has been initalized.
	Private boolSession As Boolean
	Private boolDatabase As Boolean
	Private boolWorkspace As Boolean
	Private boolUIDocument As Boolean
	Private boolDocumentExtended As Boolean
	Private boolName As Boolean
 
	'Possible objects that can be loaded
	Private sessionCurrent As NotesSession
	Private databaseCurrent As NotesDatabase
	Private workspaceCurrent As NotesUIWorkspace
	Private uiDocumentCurrent As NotesUIDocument
	Private documentExtendedCurrent As NotesDocumentExtended
	Private nameCurrent As NotesName	
 
	'/**
	' * Constructor, but nothing else is intialized until it is used.
	' */
	Public Sub New()
		Let boolSession = False
		Let boolDatabase = False
		Let boolWorkspace = False
		Let boolUIDocument = False
		Let boolDocumentExtended = False
		Let boolName = False
	End Sub
 
	'/**
	' * IntializeSession
	' */
	Private Sub intializeSession( )
		If Not boolSession Then
			Set SessionCurrent = New NotesSession()
			Let boolSession = True
		End If
	End Sub
	'/**
	' * Intialize Database
	' */
	Private Sub intializeDatabase( )
		If Not boolDatabase Then
			Call intializeSession()
			Set databaseCurrent = sessionCurrent.CurrentDatabase()
			Let boolDatabase = True
		End If
	End Sub
	'/**
	' * Intialize Document
	' */
	Private Sub intializeDocument( )
		If Not boolDocumentExtended Then
			Call intializeDatabase()
			Set documentExtendedCurrent = New NotesDocumentExtended()
			If isOnServer Then
				Call documentExtendedCurrent.setDocument ( sessionCurrent.DocumentContext() )
			Else
				Call intializeUIDocument()
				If hasUIDocument() Then
					Call documentExtendedCurrent.setDocument( uiDocumentCurrent.Document() )
				End If
			End If
			Let boolDocumentExtended = True
		End If
	End Sub
	'/**
	' * Determines if the object was loaded through the UI
	' */
	Private Function isOnServer () As Boolean
		Call intializeSession()
		isOnServer = sessionCurrent.IsOnServer()
	End Function
	'/**
	' * Intialize Workspace
	' */
	Private Sub intializeWorkspace( )
		If Not boolWorkspace Then
			If Not isOnServer Then
'Skip workspace initialization if the code is running on a server because NotesUIWorkspace would be unavailable
				Set workspaceCurrent = New NotesUIWorkspace()
			End If
			Let boolWorkspace = True
		End If
	End Sub
	'/**
	' * Intialize UI Document
	' */
	Private Sub intializeUIDocument( )
		If Not boolUIDocument Then
			If Not isOnServer Then
				Call intializeWorkspace()
				If hasWorkspace() Then
					Set uiDocumentCurrent = workspaceCurrent.CurrentDocument()
				End If
			End If
			Let boolUIDocument = True
		End If
	End Sub	
	'/**
	' * Intialize Name
	' */
	Private Sub intializeName()
		If Not boolName Then
			Call intializeSession()
			Set nameCurrent = New NotesName( sessionCurrent.EffectiveUserName ())
			Let boolName = True
		End If
	End Sub
 
	'/**
	' * Determines if a UI Workspace is available
	' */
	Public Function hasWorkspace() As Boolean
		Call intializeWorkspace()
		hasWorkspace = Not workspaceCurrent Is Nothing
	End Function
	'/**
	' * Returns the UI Workspace
	' * @return UI Workspace
	' */
	Public Function ThisWorkspace() As NotesUIWorkspace
		Call intializeWorkspace()
		Set ThisWorkspace = workspaceCurrent
	End Function
	'/**
	' * Returns the current database
	' * @return current database
	' */
	Public Function ThisDatabase() As NotesDatabase
		Call intializeDatabase()
		Set ThisDatabase = databaseCurrent
	End Function
	'/**
	' * determines if there is a current document
	' * @return True/False
	' */
	Public Function hasDocument() As Boolean
		Call intializeDocument()
		hasDocument = documentExtendedCurrent.hasDocument()
	End Function
	'/**
	' * Returns the current document
	' * @return current document
	' */
	Public Function ThisDocument() As NotesDocument
		Call intializeDocument()
		Set ThisDocument = documentExtendedCurrent.Document()
	End Function
	'/**
	' * Returns the current ui document
	' * @return current ui document
	' */
	Public Function ThisUIDocument() As NotesUIDocument
		Call intializeDocument()
		Set ThisUIDocument = uiDocumentCurrent
	End Function
	'/**
	' * Determines if a ui document is available
	' * @return True/False
	' */
	Public Function hasUIDocument() As Boolean
		Call intializeUIDocument()
		hasUIDocument = Not ( uiDocumentCurrent Is Nothing )
	End Function
	'/**
	' * Returns the current Session
	' * @return current Session
	' */
	Public Function ThisSession() As NotesSession
		Call intializeSession()
		Set ThisSession = sessionCurrent
	End Function
	'/**
	' * Returns the current Users Name object 
	' * @return current user Name object
	' */
	Public Function CurrentUser() As NotesName
		Call intializeName()
		Set CurrentUser = nameCurrent
	End Function
	'/**
	' * Returns the current users common name
	' * @return current users common name
	' */
	Public Function CurrentUserCommon() As String
		Call intializeName()
		CurrentUserCommon = nameCurrent.Common
	End Function
	'/**
	' * Returns the current users abbreviated name
	' * @return current users abbreviated name
	' */
	Public Function CurrentUserAbbreviated() As String
		Call intializeName()
		CurrentUserAbbreviated = nameCurrent.Abbreviated
	End Function
End Class
 
 
 
'/**
' * A basic class to extend the NotesDocument class to reduce
' * code and improve error checking
' * 
' *	@author	Chad Schelfhout		http://www.chadsmiley.com/
' *	@version	1.1
' *
' * @history	1.0 Created
' * 					1.1 converted properties to function/subs and ported to Java
' */
Class NotesDocumentExtended
	Private pDoc As NotesDocument
 
	'/**
	' * Constructor
	' */
	Public Sub New()
	End Sub
	'/**
	' * Returns the Values ofthe field if it is availabe
	' * @param fieldName The name of the field on the document
	' * @return the values of the field, or nothing
	' */
	Public Function getFieldValues ( fieldName As String ) As Variant
		Set getFieldValues = Nothing
		If hasDocument() Then
			If pDoc.hasItem( fieldName ) Then
				getFieldValues = pDoc.getFirstItem( fieldName).Values
			End If
		End If
	End Function
	'/**
	' * Returns the Values ofthe field if it is availabe
	' * @param fieldName The name of the field on the document
	' * @return the notes item of the field, or nothing
	' */
	Public Function getFieldItem ( fieldName As String ) As NotesItem
		Set getFieldItem = Nothing
		If hasDocument() Then
			If pDoc.hasItem( fieldName ) Then
				Set getFieldItem = pDoc.getFirstItem( fieldName)
			End If
		End If
	End Function
	'/**
	' * Replaces the fields value with the new one supplied
	' * @param fieldName The name of the field on the document
	' * @param Item the new value for the field
	' */
	Public Sub replaceField ( fieldName As String , Var As Variant )
		If hasDocument() Then
			Call pDoc.ReplaceItemValue( fieldName , Var )
		End If
	End Sub
	'/**
	' * Returns the text representation of fields value
	' * @param fieldName The name of the field on the document
	' * @return the fields value as a string
	' */
	Public Function getFieldText ( fieldName As String ) As String
		getFieldText = ""
		If hasDocument() Then
			If pDoc.hasItem( fieldName ) Then
				getFieldText = pDoc.getFirstItem( fieldName).text
			End If
		End If
	End Function
	'/**
	' * Determines if the field exists on the document
	' * @param fieldName The name of the field on the document
	' * @return weather the field exists
	' */
	Public Function hasField ( fieldName As String ) As Boolean
		hasField = False
		If hasDocument() Then
			hasField = pDoc.hasItem( fieldName )
		End If
	End Function
	'/**
	' * Determines if the field has text. by converting all values to text and checking the length
	' * @param fieldName The name of the field on the document
	' * @return weather the text length is zero
	' */
	Public Function hasFieldText ( fieldName As String ) As Boolean
		hasFieldText = False
		If hasDocument() Then
			hasFieldText = ( Len( getFieldText( fieldName ) ) > 0 )
		End If
	End Function
	'/**
	' * Determines if a document exists
	' * @return weather there is a document
	' */
	Public Function hasDoc ( ) As Boolean
		hasDoc = Not ( pDoc Is Nothing )
	End Function
	'/**
	' * Determines if a document exists
	' * @return weather there is a document
	' */
	Public Function hasDocument ( ) As Boolean
		hasDocument = Not ( pDoc Is Nothing )
	End Function
	'/**
	' * Returns the true NotesDocument
	' * @return the NotesDocument
	' */
	Public Sub setDoc ( Doc As NotesDocument )
		Set pDoc = Doc
	End Sub
	'/**
	' * Returns the true NotesDocument
	' * @return the NotesDocument
	' */
	Public Function Doc() As NotesDocument
		Set Doc = pDoc
	End Function
	'/**
	' * Sets the true NotesDocument
	' * @param the NotesDocument
	' */
	Public Sub setDocument ( Document As NotesDocument )
		Set pDoc = Document 
	End Sub
	'/**
	' * Returns the true NotesDocument
	' * @return the NotesDocument
	' */
	Public Function Document As NotesDocument
		Set Document = pDoc
	End Function
End Class
 
 
Sub Initialize
	Set System = New NotesSystem()
End Sub
</textarea>
<h3>Java NotesSystem</h3>
<a href="javascript:highlight(2)"> Select All</a><BR><BR>
<textarea rows="20" cols=60" wrap="virtual" class="codebox200" id="FormulaCodeBlock2" onFocus="javascript:highlight(2)" title="Use the Select All link above to select all the text.">
package com.ChadSmiley.domino.Extended;
 
import lotus.domino.Database;
import lotus.domino.Document;
import lotus.domino.Name;
import lotus.domino.NotesException;
import lotus.domino.NotesFactory;
import lotus.domino.Session;
 
/**
 * A basic class to extend the NotesDocument class to reduce
 * code and improve error checking
 * 
 * @author	Tim Tripcony				http://www.timtripcony.com
 * @author	Chad Schelfhout		http://www.chadsmiley.com/
 * 	
 * @version	1.0	Created by Tim
 * @version	1.1	Split intialization, each object is initalized only when it is needed
 * @version	1.2	Converted NotesDocument to NotesDocumentExtended
 * @version	1.3	Converted properties to Function so it is easily ported to Java
 */
 
public class NotesSystem {
//	Used to determine if( each object has been initalized.
	private boolean boolSession;
	private boolean boolDatabase;
//	private boolean boolWorkspace;
//	private boolean boolUIDocument;
	private boolean boolDocumentExtended;
	private boolean boolName;
 
//	Possible objects that can be loaded
	private Session sessionCurrent;
	private Database databaseCurrent;
//	private UIWorkspace workspaceCurrent;
//	private UIDocument uiDocumentCurrent;
	private DocumentExtended documentExtendedCurrent;
	private Name nameCurrent;
 
	/**
	 * Constructor, but nothing else is intialized until it is used.
	 */
	public NotesSystem(){
		 boolSession = false;
		 boolDatabase = false;
//		 boolWorkspace = false;
//		 boolUIDocument = false;
		 boolDocumentExtended = false;
		 boolName = false;
	}
 
	/**
	 * IntializeSession
	 */
	private void intializeSession( ){
		if( ! boolSession) {
			try {
				sessionCurrent = NotesFactory.createSession();
			} catch (NotesException e) {
				sessionCurrent = null;
			};
			boolSession = true;
		}
	}
	/**
	 * Intialize Database
	 */
	private void intializeDatabase( ){
		if( ! boolDatabase) {
			intializeSession();
			try {
				databaseCurrent = sessionCurrent.getAgentContext().getCurrentDatabase();
			} catch (NotesException e) {
				databaseCurrent = null;
			}
			boolDatabase = true;
		}
	}
	/**
	 * Intialize Document
	 */
	private void intializeDocument( ){
		if( ! boolDocumentExtended ) {
			intializeDatabase();
			documentExtendedCurrent = new DocumentExtended();
			if( isOnServer()) {
				try {
					documentExtendedCurrent.setDocument( sessionCurrent.getAgentContext().getDocumentContext() );
				} catch (NotesException e) {
				}
			}else{
//				intializeUIDocument();
//				if( hasUIDocument()) {
//					documentExtendedCurrent.Document = uiDocumentCurrent.getDocument();
//				}
			}
			boolDocumentExtended = true;
		}
	}
	/**
	 * Determines if( the object was loaded through the UI
	 */
	private boolean isOnServer (){
		intializeSession();
		try {
			return sessionCurrent.isOnServer();
		} catch (NotesException e) {
			return false;
		}
	}
//	/**
//	 * Intialize Workspace
//	 */
//	private void intializeWorkspace( ){
//		if( ! boolWorkspace) {
//			if( ! isOnServer) {
////Skip workspace initialization if( the code is running on a server because NotesUIWorkspace would be unavailable
//				workspaceCurrent = new UIWorkspace();
//			}
//			 boolWorkspace = true;
//		}
//	}
//	/**
//	 * Intialize UI Document
//	 */
//	private void intializeUIDocument( )
//		if( ! boolUIDocument) {
//			if( ! isOnServer) {
//				intializeWorkspace();
//				if( hasWorkspace()) {
//					uiDocumentCurrent = workspaceCurrent.getCurrentDocument();
//				}
//			}
//			boolUIDocument = true;
//		}
//	}	
	/**
	 * Intialize Name
	 */
	private void intializeName(){
		if( ! boolName) {
			intializeSession();
			try {
				nameCurrent = sessionCurrent.getUserNameObject();
			} catch (NotesException e) {
			}
			boolName = true;
		}
	}
 
//	/**
//	 * Determines if( a UI Workspace is available
//	 */
//	public boolean hasWorkspace() {
//		intializeWorkspace();
//		hasWorkspace = workspaceCurrent != null;
//	}
	/**
	 * Returns the current database
	 * @return current database
	 */
	public Database thisDatabase() {
		intializeDatabase();
		return databaseCurrent;
	}
	/**
	 * determines if( there is a current document
	 * @return true/false
	 */
	public boolean hasDocument(){
		intializeDocument();
		return documentExtendedCurrent.hasDocument();
	}
 
	/**
	 * Returns the current document
	 * @return current document
	 */
	public Document thisDocument() {
		intializeDocument();
		return documentExtendedCurrent.getDocument();
	}
//	/**
//	 * Returns the current ui document
//	 * @return current ui document
//	 */
//	public UIDocument ThisUIDocument(){
//		intializeDocument();
//		return uiDocumentCurrent;
//	}
//	/**
//	 * Determines if a ui document is available
//	 * @return true/false
//	 */
//	public boolean hasUIDocument(){
//		intializeUIDocument();
//		hasUIDocument = uiDocumentCurrent != null;
//	}
	/**
	 * Returns the current Session
	 * @return current Session
	 */
	public Session thisSession() {
		intializeSession();
		return sessionCurrent;
	}
	/**
	 * Returns the current Users Name object 
	 * @return current user Name object
	 */
	public Name currentUser(){
		intializeName();
		return nameCurrent;
	}
	/**
	 * Returns the current users common name
	 * @return current users common name
	 */
	public String currentUserCommon(){
		intializeName();
		try {
			return nameCurrent.getCommon();
		} catch (NotesException e) {
			return "";
		}
	}
	/**
	 * Returns the current users abbreviated name
	 * @return current users abbreviated name
	 */
	public String currentUserAbbreviated(){
		intializeName();
		try {
			return nameCurrent.getAbbreviated();
		} catch (NotesException e) {
			return "";
		}
	}
}
</textarea>
<h3>Java DocumentExtended</h3>
<a href="javascript:highlight(3)"> Select All</a><BR><BR>
<textarea rows="20" cols=60" wrap="virtual" class="codebox200" id="FormulaCodeBlock3" onFocus="javascript:highlight(3)" title="Use the Select All link above to select all the text.">
package com.ChadSmiley.domino.Extended; 
 
import java.util.Vector;
 
import lotus.domino.Document;
import lotus.domino.NotesException;
 
/**
 * A basic class to extend the NotesDocument class to reduce
 * code and improve error checking
 * 
 * @author Chad Schelfhout http://www.chadsmiley.com
 * @version 1.1
 * 
 * @history	1.0 Created in LotusScript
 * 			1.1 Created in Java
 */
public class DocumentExtended {
	private Document pDoc = null;
 
	/**
	 * Determines if the Notes Document has been Set
	 * @return boolean
	 */
	public boolean hasDoc() {
		return pDoc != null;
	}
	/**
	 * Determines if the Notes Document has been Set
	 * @return boolean
	 */
	public boolean hasDocument() {
		return pDoc != null;
	}
 
	/**
	 * Returns the a Notes Document.
	 * @return Document
	 */
	public Document getDoc() {
		return pDoc;
	}
	/**
	 * Returns the a Notes Document.
	 * @return Document
	 */
	public Document getDocument() {
		return pDoc;
	}
 
	/**
	 * Sets the Notes Document.
	 * @param Doc The Notes Document to set
	 */
	public void setDoc(Document Doc) {
		this.pDoc = Doc;
	}
 
	/**
	 * Sets the Notes Document.
	 * @param Doc The Notes Document to set
	 */
	public void setDocument(Document Doc) {
		this.pDoc = Doc;
	}
 
	public String getFieldText( String fieldName ){
		try {
			if ( hasField( fieldName ) ){
				return pDoc.getFirstItem( fieldName ).getText();
			}else{
				return "";
			}
		} catch (Exception e) {
			return "";
		}
	}
 
	public void recycle(){
		try {
			if ( pDoc != null ){
				pDoc.recycle();
				pDoc = null;
			}
		} catch (Exception e) {
		}
	}
	public void finalize(){
		recycle();
	}
	/**
	 * Method hasField.
	 * @param FromURLField
	 * @return boolean
	 */
	public boolean hasField(String fieldName) {
		try {
			if( hasDocument() ){
					if ( pDoc.hasItem( fieldName ) ){
						return true;
					}
			}
			return false;
		} catch (NotesException e) {
			return false;
		}
	}
 
	/**
	 * Method getFieldValues.
	 * @param DynamicFormFIELD
	 * @return Vector
	 */
	public Vector getFieldValues(String fieldName) {
		try {
			if ( hasField( fieldName ) ){
				return pDoc.getFirstItem( fieldName ).getValues();
			}else{
				return new Vector();
			}
		} catch (NotesException e) {
			return new Vector();
		}
	}
}