Library baliUtils_nlsxBE

Methods Detail

• copyDocumentHierarchyToDatabase

  Public Function copyDocumentHierarchyToDatabase(source As NotesDocument, target As NotesDatabase, newdoc As NotesDocument) As StringQueue
  Copies a source document to a target database. If a document has responses, the responses (and their heirarchy as well) will also be copied to the target database.
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		Document to be copied to the target database.
  2	target	NotesDatabase		Database to which the document (and it's descendants) will be copied.
  3	newdoc	NotesDocument		{!!OUTBOUND!!} New document in the target database

• getACLlevel

  Public Function getACLlevel(acl As Integer) As String
  Gets the string representation of an ACL level integer
  idx	Argument	Data Type	Attributes	Comments
  1	acl	Integer		ACL Level to check.

• getAncestorByForm

  Public Function getAncestorByForm(source As NotesDocument, form As String, allowself As Boolean) As NotesDocument
  Gets an Ancestor document matching the specified form. Conditionally walks a document's ancestry to find a document matching the requested form.
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesDocument object for which to retrieve the ancestor document.
  2	form	String		Name of the form for which to search in the document's ancestry
  3	allowself	Boolean		Flag indicating the source document should be returned if it matches the form.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if the source document is nothing.
  MSG_PARAMETER_BLANK	1199	if the form is blank

• getCollectionUNIDs

  Public Function getCollectionUNIDs(col As NotesDocumentCollection) As StringQueue
  Gets the UniversalIDs from a NotesDocumentCollection.
  idx	Argument	Data Type	Attributes	Comments
  1	col	NotesDocumentCollection		Collection from which to get the Universal IDs
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if the passed in collection is Nothing

• getConfigUNID

  Public Function getConfigUNID(source As String, clearCache As Boolean) As String
  Gets the UNID of the DbConfig document for a given source form. Only 1 DbConfig document may exist for a specified form.
  idx	Argument	Data Type	Attributes	Comments
  1	source	String	ByVal	Form of the specified DbConfig document.
  2	clearCache	Boolean		Flag indicating if cached information should be cleared.

• getDbConfigDoc

  Public Function getDbConfigDoc(source As String, clearCache As Boolean) As NotesDocument
  Gets the DbConfig document for the specified Form. Only 1 DbConfig document may exist for a specified form.
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		Form for the specified DbConfig document.
  2	clearCache	Boolean		Flag indicating if the cached information should be cleared.

• getDocumentByUNID

  Public Function getDocumentByUNID(universalID As String) As NotesDocument
  Gets the document from the current database for the specified UniversalID.
  idx	Argument	Data Type	Attributes	Comments
  1	universalID	String	ByVal	UniversalID of the target document.

• getEmptyDocumentCollection

  Public Function getEmptyDocumentCollection(source As NotesDatabase) As NotesDocumentCollection
  Creates an empty NotesDocumentCollection from the source database.
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDatabase		NotesDatabase from within which to create the empty document collection.

• getEnvarName

  Public Function getEnvarName(source As String, clearCache As Boolean) As String
  Constructs a valid Envirionment Variable Name from a given source string.
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String from which to construct the Environment Variable Name.
  2	clearCache	Boolean		Flag indicating if cached information should be cleared.

• getHashedValue

  Public Function getHashedValue(source As String, clearCache As Boolean) As String
  Hashes a source String. Uses the @Password function to perform the hash
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to Hash.
  2	clearCache	Boolean		Flag indicating if cached information should be cleared.

• getItemValueText

  Public Function getItemValueText(source As NotesDocument, itemname As String, delimiter As String, htreplace As String) As String
  Gets the Item Value Text for a Notes Item. Multi-Value Text Items will conditionally concatenated with the specified delimiter
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesDocument containing the NotesItem
  2	itemname	String		Name of the NotesItem from which to retrieve the Text
  3	delimiter	String		Delimiter to use for concatenating multi-value text items.
  4	htreplace	String		String used to replace horizontal tabs in RichText content.

• getOpenDatabase

  Public Function getOpenDatabase(server As String, filepath As String) As NotesDatabase
  Attempts to open a database.
  idx	Argument	Data Type	Attributes	Comments
  1	server	String		Name of server containing the database.
  2	filepath	String		Filepath for the database to open.

• getParentDocument

  Public Function getParentDocument(source As NotesDocument) As NotesDocument
  Gets the Parent document (if it exists) for a document.
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesDocument for which to get the Parent

• getViewUNIDs

  Public Function getViewUNIDs(source As NotesView) As StringQueue
  Gets the UniversalIDs of all documents in a view, in view order. NOTE: If a document appears in a view multiple times then it's associated UniversalID will be in the result multiple times as well.
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesView		View from which to get all document UniversalIDs
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source view is Nothing

• isPlatformWindows

  Public Function isPlatformWindows() As Boolean
  Indicates if the current platform is a Windows OS.

• safeEvaluate

  Public Function safeEvaluate(formula As String, context As Variant, failValue As Variant) As Variant
  valuates a formula and returns the result.
  idx	Argument	Data Type	Attributes	Comments
  1	formula	String		Formula to evaluate
  2	context	Variant		Context object for which the formula should be run
  3	failValue	Variant		Value to return in the event of a failure.

• getCurrentDb

  Static Public Function getCurrentDb() As NotesDatabase
  Gets a handle to the current database

• getCurrentSession

  Static Public Function getCurrentSession() As NotesSession
  handle to the current NotesSession