Database (HCL Domino API 1.0.27-SNAPSHOT API)

All Superinterfaces:

AutoCloseable, DominoClientDescendant, IAdaptable
```
public interface Database
extends IAdaptable, AutoCloseable, DominoClientDescendant
```
Access to an individual database and its documents, indicies and design

Author:

t.b.d

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Database.AccessInfo`
`static class`	`Database.Action`
`static class`	`Database.CollectionType`
`static class`	`Database.CreateFlags`
`static class`	`Database.DocFlags`
`static interface`	`Database.DocInfo` Data container that stores the lookup result for document info
`static interface`	`Database.DocInfoExt` Extension of `Database.DocInfo` with additional note lookup data
`static interface`	`Database.EncryptionInfo` Represents the local encryption information for a database.
`static interface`	`Database.FormulaQueryCallback`
`static interface`	`Database.ModifiedNoteInfo`
`static interface`	`Database.ModifiedNoteInfos`
`static class`	`Database.ModifiedNotesInfoFlags` Flags to control the output of `getModifiedNotesInfo(Set, Set, TemporalAccessor, boolean, TemporalAccessor)`
`static class`	`Database.ModifiedTableMode`
`static interface`	`Database.NSFVersionInfo`
`static class`	`Database.OpenDocumentMode` Flags to control how to open a document.
`static class`	`Database.ReplicateOption`
`static interface`	`Database.SearchMatch` Container with information about each document received for an NSF search, containing the document note id / UNID, modified dates, document class and document flags.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addToFolder(int folderNoteId, Collection<Integer> noteIds)` Adds note ids to a folder
`void`	`addToFolder(String folderName, Collection<Integer> noteIds)` Adds note ids to a folder
`void`	`close()` Closes the database, releasing its handle and allowing it to be deleted.
`int`	`copyFolder(int sourceFolderNoteId, String newFolderName)` Creates a copy of a folder including its content
`int`	`copyFolder(String sourceFolderName, String newFolderName)` Creates a copy of a folder including its content
`Document`	`createDocument()`
`Document`	`createDocument(Set<Database.CreateFlags> flags)`
`DocumentSelection`	`createDocumentSelection()` Creates a new `DocumentSelection` to select data or design documents.
`int`	`createFolder(Database formatDb, int formatFolderNoteId, String newFolderName)` Creates a new folder in the database with the design of the specified folder/view in another database
`int`	`createFolder(Database formatDb, String formatFolderName, String newFolderName)` Creates a new folder in the database with the design of the specified folder/view in another database
`int`	`createFolder(int formatFolderNoteId, String newFolderName)` Creates a new folder in the database with the design of the specified folder/view
`int`	`createFolder(String newFolderName)` Creates a new folder in the database with the default view/folder design
`int`	`createFolder(String formatFolderName, String newFolderName)` Creates a new folder in the database with the design of the specified folder/view
`QueryResultsProcessor`	`createQueryResultsProcessor()` Creates a `QueryResultsProcessor` to process the results of multi-database queries
`void`	`deleteDocument(int noteId)`
`void`	`deleteDocument(String unid)`
`void`	`deleteDocuments(Collection<Integer> noteIds)`
`void`	`deleteDocumentsByUNID(Collection<String> unids)`
`void`	`deleteFolder(int folderNoteId)` Deletes a folder
`void`	`deleteFolder(String folderName)` Deletes a folder
`void`	`deleteFTIndex()` This function deletes a full text index and disables full text indexing for a database.
`int`	`findCollectionId(String name, Database.CollectionType type)` Looks up a collection by name in the database design
`void`	`forEachCollection(BiConsumer<DominoCollectionInfo,Loop> consumer)` Iterates over all collections in this database
`void`	`forEachProfileDocument(BiConsumer<Document,Loop> consumer)` Iterates over all profile documents in the database
`void`	`forEachProfileDocument(String profileName, BiConsumer<Document,Loop> consumer)` Iterates over all profile documents of the specified type in the database
`void`	`forEachProfileDocument(String profileName, String userName, BiConsumer<Document,Loop> consumer)` Iterates over all profile documents of the specified type/username in the database
`FTIndexStats`	`ftIndex(Set<FTIndex> options)` This function creates a new full text index for a local database. Synchronous full text indexing of a remote database is currently not supported.
`void`	`ftIndexRequest()` Requests an asynchronous update of the full text index
`DominoOriginatorId`	`generateOID()` This function generates a new Originator ID (OID) used to uniquely identify a document. Use this function when you already have a document open and wish to create a totally new document with the same items as the open document. You do not need this method when creating a new note from scratch using `createDocument()`, because the OID is already generated for you. If the database resides on a remote Lotus Domino Server, the current user must to have the appropriate level of access to carry out this operation.
`String`	`generateUNID()`
`String`	`getAbsoluteFilePath()` Retrieves the file path of the database.
`Acl`	`getACL()`
`Optional<Agent>`	`getAgent(String agentName)` Looks up and loads an agent in the database design
`Optional<Document>`	`getAgentSavedData(String agentName)` The returned document is created when you save an agent, and it is stored in the same database as the agent. The document replicates, but is not displayed in views. Each time you edit and re-save an agent, its saved data document is deleted and a new, blank one is created.
`Stream<DominoCollectionInfo>`	`getAllCollections()` Returns a `Stream` of `DominoCollectionInfo` objects that contain infos about the collections in the database.
`Map<String,Map<String,Integer>>`	`getAllDocumentsByPrimaryKey()` Returns the note id of all documents with assigned primary key (via `Document.setPrimaryKey(String, String)`, hashed by their category value and object id
`Map<String,Integer>`	`getAllDocumentsByPrimaryKey(String category)` Returns the note id of all documents with `category` in the assigned primary key (via `Document.setPrimaryKey(String, String)`, hashed by their category value and object id
`IDTable`	`getAllNoteIds(Set<DocumentClass> docClasses, boolean includeDeletions)` This function returns an `IDTable` of all note IDs in the database with the given set of `DocumentClass`. If `includeDeletions` is set to TRUE, the returned IDTable also contains the note IDs of deleted documents.
`BuildVersionInfo`	`getBuildVersionInfo()` This function returns a `BuildVersionInfo` object which contains all types of information about the level of code running on a machine. See `BuildVersionInfo` for more information.
`String`	`getCategories()`
`DbDesign`	`getDesign()`
`String`	`getDesignTemplateName()` The name of the design template from which a database inherits its design. If the database does not inherit its design from a design template, it returns an empty string ("").
`Optional<Document>`	`getDocumentById(int noteId)` Opens a document in the database
`Optional<Document>`	`getDocumentById(int noteId, Set<Database.OpenDocumentMode> flags)` Opens a document in the database
`Optional<Document>`	`getDocumentByPrimaryKey(String category, String objectId)` Uses an efficient NSF lookup mechanism to find a document that matches the primary key specified with `category` and `objectKey`.
`Optional<Document>`	`getDocumentByUNID(String unid)` Opens a document in the database
`Optional<Document>`	`getDocumentByUNID(String unid, Set<Database.OpenDocumentMode> flags)` Opens a document in the database
`Database.DocInfoExt`	`getDocumentInfo(int noteId)`
`Database.AccessInfo`	`getEffectiveAccessInfo()` Retrieves the current effective access level and flags for the open database.
`int`	`getFolderDocCount(int folderNoteId)` This function returns the number of entries in the specified folder's index. This is the number of documents plus the number of categories (if any) in the folder. Subfolders and documents in subfolders are not included in the count.
`int`	`getFolderDocCount(String folderName)` This function returns the number of entries in the specified folder's index. This is the number of documents plus the number of categories (if any) in the folder. Subfolders and documents in subfolders are not included in the count.
`IDTable`	`getIDTableForFolder(int folderNoteId, boolean validateIds)` This function gets the Note IDs of notes in a folder and returns a IDTable.
`IDTable`	`getIDTableForFolder(String folderName, boolean validateIds)` This function gets the Note IDs of notes in a folder and returns a IDTable.
`NavigableMap<String,ItemDataType>`	`getItemDefinitionTable()` The extended version of the Item Definition Table for a database contains the number of items, name and type of all the items defined in that database. Examples are field names, form names, design names, and formula labels. Applications can obtain a copy of the extended version of the Item Definition Table by calling this method.
`Optional<DominoDateTime>`	`getLastFTIndexTime()` This routine returns the last time a database was full text indexed.
`Database.EncryptionInfo`	`getLocalEncryptionInfo()`
`IDTable`	`getModifiedNoteIds(Set<DocumentClass> docClasses, TemporalAccessor since, boolean includeDeletions)` This function returns an `IDTable` of Note IDs of documents which have been modified in some way from the given starting time until "now". The ending date/time is returned in `IDTable.getDateTime()`, so that this function can be performed incrementally. The returned IDTable also contains the note IDs of deleted documents.
`Database.ModifiedNoteInfos`	`getModifiedNotesInfo(Set<DocumentClass> docClasses, Set<Database.ModifiedNotesInfoFlags> infoRequested, TemporalAccessor sinceParam, boolean includeDeletions, TemporalAccessor optUntilParam)` Returns information about documents modified since the specified date/time
`void`	`getModifiedTime(Ref<DominoDateTime> retDataModified, Ref<DominoDateTime> retNonDataModified)` This function obtains the date/time of the last modified data and non-data documents in the specified database.
`Database.DocInfo[]`	`getMultiDocumentInfo(int[] noteIds)` This method can be used to get information for a number documents in a database from their note ids in a single call. The data returned by this method is the note id, the UNID of the document, the sequence number and the sequence time ("Modified initially" time). In addition, the method checks whether a document exists or has been deleted.
`Database.DocInfo[]`	`getMultiDocumentInfo(String[] noteUNIDs)` This method can be used to get information for a number documents in a database from their note unids in a single call. The data returned by this method is the note id the UNID of the document, the sequence number and the sequence time ("Modified initially" time). In addition, the method checks whether a document exists or has been deleted.
`Optional<UserNamesList>`	`getNamesList()` This function returns a `UserNamesList` structure.
`Database.NSFVersionInfo`	`getNSFVersionInfo()` Reads information about the On-Disk-Structure (ODS) of the database.
`boolean`	`getOption(DatabaseOption option)` Gets the value of a database option
`Set<DatabaseOption>`	`getOptions()` Returns the `DatabaseOption` values for the database
`Optional<Document>`	`getProfileDocument(String profileName)`
`Optional<Document>`	`getProfileDocument(String profileName, String userName)`
`String`	`getRelativeFilePath()` Retrieves the file path of the database relative to the containing host's data directory.
`String`	`getReplicaID()`
`String`	`getServer()`
`Optional<Document>`	`getSoftDeletedDocumentById(int noteId)` Opens a soft deleted document in the database
`Optional<Document>`	`getSoftDeletedDocumentByUNID(String unid)` Opens a soft deleted document in the database
`String`	`getTemplateName()` The template name of a database, if the database is a template.
`String`	`getTitle()`
`Optional<IDTable>`	`getUnreadDocumentTable(String userName, boolean createIfNotAvailable, boolean updateUnread)` An ID Table is created containing the list of unread documents in the database for the specified user. The argument `createIfNotAvailable` controls what action is to be performed if there is no list of unread notes for the specified user in the database. If no list is found and this flag is set to `false`, the method will return `null`. if this flag is set to {code true}, the list of unread documents will be created and all documents in the database will be added to the list. No coordination is performed between different users of the same database. If an application obtains a list of unread documents while another user is modifying the list, the changes made may not be visible to the application. Unread marks for each user are stored in the client desktop.dsk file and in the database. When a user closes a database (either through the Notes user interface or through an API program), the unread marks in the desktop.dsk file and in the database are synchronized so that they match. Unread marks are not replicated when a database is replicated. Instead, when a user opens a replica of a database, the unread marks from the desktop.dsk file propagates to the replica database.
`void`	`hardDeleteDocument(int softDelNoteId)` This function permanently deletes the specified "soft deleted" document from the database. The deleted document may be of any `DocumentClass`.
`boolean`	`hasFullAccess()` Checks whether we have full access on a database
`boolean`	`isDocumentLockingEnabled()`
`boolean`	`isDocumentUnread(String userName, int noteId)` Checks if a document is in the unread table for the specified user. For performance reasons we internally cache the unread table and store the username.
`boolean`	`isFTIndex()`
`boolean`	`isLargeSummaryEnabled()`
`boolean`	`isLocallyEncrypted()` Determines whether the database is locally encrypted.
`boolean`	`isRemote()` Checks whether a database is located on a remote server
`void`	`moveFolder(int folderNoteId, int newParentFolderNoteId)` Moves a folder below another one
`void`	`moveFolder(String folderName, String newParentFolderName)` Moves a folder below another one
`Optional<DominoCollection>`	`openCollection(String collectionName)`
`Optional<DominoCollection>`	`openCollectionByUNID(String unid)`
`Optional<DominoCollection>`	`openDefaultCollection()`
`DominoCollection`	`openDesignCollection()` Opens and returns the design collection
`List<String>`	`queryAccessRoles(String userName)` Convenience method to look up the roles for a user from the database `Acl`. Use `Acl.lookupAccess(UserNamesList)` if you need other access information for the same user as well.
`DocumentSummaryQueryResult`	`queryDocuments()` Runs an operation on all documents in the database
`DocumentSummaryQueryResult`	`queryDocuments(Collection<Integer> ids)` Runs an operation on a number of documents in the database
`DQLQueryResult`	`queryDQL(DQL.DQLTerm query)` Runs a DQL query against the documents in the database.
`DQLQueryResult`	`queryDQL(DQL.DQLTerm query, Set<DBQuery> flags)` Runs a DQL query against the documents in the database.
`DQLQueryResult`	`queryDQL(DQL.DQLTerm query, Set<DBQuery> flags, int maxDocsScanned, int maxEntriesScanned, int maxMsecs)` Runs a DQL query against the documents in the database.
`DQLQueryResult`	`queryDQL(String query)` Runs a DQL query against the documents in the database.
`DQLQueryResult`	`queryDQL(String query, Set<DBQuery> flags)` Runs a DQL query against the documents in the database.
`DQLQueryResult`	`queryDQL(String query, Set<DBQuery> flags, int maxDocsScanned, int maxEntriesScanned, int maxMsecs)` Runs a DQL query against the documents in the database.
`FormulaQueryResult`	`queryFormula(String selectionFormula, IDTable filter, Set<DirectorySearchQuery.SearchFlag> searchFlags, TemporalAccessor since, Set<DocumentClass> docClass)` Evaluates a formula on a set of documents or the whole database
`DominoDateTime`	`queryFormula(String selectionFormula, Set<Integer> filter, Set<DirectorySearchQuery.SearchFlag> searchFlags, TemporalAccessor since, Set<DocumentClass> docClass, Map<String,String> computeValues, Database.FormulaQueryCallback callback)`
`FTQueryResult`	`queryFTIndex(String query, int maxResults, Set<FTQuery> options, Set<Integer> filterIds, int start, int count)` Performs a fulltext search in the database with advanced options.
`void`	`refreshDesign(String server)` This function will refresh the database design, as allowed by the database/design properties and access control of Domino, from a server's templates. The refreshed database, if open in Domino or Notes at the time of refresh, must be closed and reopened to view any changes. Convenience function that calls `#refreshDesign(String, boolean, boolean, IBreakHandler)` with force and errIfTemplateNotFound set to true and without break handler.
`void`	`refreshDesign(String server, boolean force, boolean errIfTemplateNotFound, DominoClient.IBreakHandler abortHandler)` This function will refresh the database design, as allowed by the database/design properties and access control of Domino, from a server's templates. The refreshed database, if open in Domino or Notes at the time of refresh, must be closed and reopened to view any changes.
`void`	`removeAllFromFolder(int folderNoteId)` Removes all note ids from a folder
`void`	`removeAllFromFolder(String folderName)` Removes all note ids from a folder
`void`	`removeFromFolder(int folderNoteId, Collection<Integer> noteIds)` Removes note ids from a folder
`void`	`removeFromFolder(String folderName, Collection<Integer> noteIds)` Removes note ids from a folder
`void`	`renameFolder(int oldFolderNoteId, String newFolderName)` Renames a folder
`void`	`renameFolder(String oldFolderName, String newFolderName)` Renames a folder
`Database`	`reopen()` Re-opens the database with a new handle.
`DominoClient.NotesReplicationStats`	`replicate(String serverName)` Bidirectional replication of this database with another server
`DominoClient.NotesReplicationStats`	`replicate(String serverName, Set<Database.ReplicateOption> options, int timeLimitMin, DominoClient.ReplicationStateListener progressListener)` Replicate database with additional options
`void`	`setCategories(String categories)`
`void`	`setDesignTemplateName(String newDesignTemplateName)` Changes the name of the design template from which a database inherits its design
`void`	`setDocumentLockingEnabled(boolean b)`
`void`	`setOption(DatabaseOption option, boolean flag)` Sets the value of a database option
`void`	`setTemplateName(String newTemplateName)` Changes the template name of a template database.
`void`	`setTitle(String title)`
`int`	`toNoteId(String unid)` Converts a single UNID to a note id
`void`	`toNoteIds(Collection<String> unids, Map<String,Integer> resolvedNoteIDsByUNID, Set<String> unresolvedUNIDs)` Bulk conversion of UNIDs to note ids
`String`	`toUNID(int noteId)` Converts a single note ID to a UNID
`void`	`toUNIDs(Collection<Integer> noteIds, Map<Integer,String> resolvedUNIDsByNoteId, Set<Integer> unresolvedNoteIds)` Bulk conversion of note ids to UNIDs
`void`	`updateDQLDesignCatalog(boolean rebuild)` Harvest view design elements for optimized DQL performance.
`void`	`updateUnreadDocumentTable(String userName, Set<Integer> noteIdToMarkRead, Set<Integer> noteIdsToMarkUnread)` Method to apply changes to the unread document table

Methods inherited from interface com.hcl.domino.data.IAdaptable
getAdapter

Methods inherited from interface com.hcl.domino.misc.DominoClientDescendant
getParentDominoClient

Method Detail

getServer
```
String getServer()
```

getRelativeFilePath
```
String getRelativeFilePath()
```
Retrieves the file path of the database relative to the containing host's data directory.

Returns:

a data-relative path to the database

getAbsoluteFilePath
```
String getAbsoluteFilePath()
```
Retrieves the file path of the database.
If the database is on a remote server, this path will be relative to the server's data directory.

If the database is local, this will be an absolute local file path.

Returns:

a data-relative or absolute path to the database, depending on host

getReplicaID
```
String getReplicaID()
```

getTitle
```
String getTitle()
```

setTitle
```
void setTitle(String title)
```

isRemote
```
boolean isRemote()
```
Checks whether a database is located on a remote server

Returns:

true if remote

hasFullAccess
```
boolean hasFullAccess()
```
Checks whether we have full access on a database

Returns:

true if full access

getACL
```
Acl getACL()
```

openCollection

Optional<DominoCollection> openCollection(String collectionName)

openCollectionByUNID
```
Optional<DominoCollection> openCollectionByUNID(String unid)
```
Parameters:

unid - the UNID of a view or folder note to open

Returns:

an Optional describing the requested collection, or an empty one if the note does not exist

openDefaultCollection

Optional<DominoCollection> openDefaultCollection()

openDesignCollection
```
DominoCollection openDesignCollection()
```
Opens and returns the design collection

Returns:

design collection

forEachCollection
```
void forEachCollection(BiConsumer<DominoCollectionInfo,Loop> consumer)
```
Iterates over all collections in this database

Parameters:

consumer - consumer to receive collection info

getAllCollections
```
Stream<DominoCollectionInfo> getAllCollections()
```
Returns a Stream of DominoCollectionInfo objects that contain infos about the collections in the database.

Returns:

collection info stream

getDocumentById
```
Optional<Document> getDocumentById(int noteId)
```
Opens a document in the database

Parameters:

noteId - the ID of the document to retrieve

Returns:

an Optional describing the document matching that ID, or an empty one if there is no such document

Throws:

DocumentDeletedException - if the document has been deleted

getDocumentById
```
Optional<Document> getDocumentById(int noteId,
                                   Set<Database.OpenDocumentMode> flags)
```
Opens a document in the database

Parameters:

noteId - the ID of the document to retrieve

flags - the flags to control the document-opening mode

Returns:

an Optional describing the document matching that ID, or an empty one if there is no such document

Throws:

DocumentDeletedException - if the document has been deleted

getSoftDeletedDocumentById
```
Optional<Document> getSoftDeletedDocumentById(int noteId)
```
Opens a soft deleted document in the database

Parameters:

noteId - the ID of the document to retrieve

Returns:

an Optional describing the soft-deleted document matching that ID, or an empty one if there is no such document

getSoftDeletedDocumentByUNID
```
Optional<Document> getSoftDeletedDocumentByUNID(String unid)
```
Opens a soft deleted document in the database

Parameters:

unid - the UNID of the document to retrieve

Returns:

an Optional describing the soft-deleted document matching that UNID, or an empty one if there is no such document

getDocumentByUNID
```
Optional<Document> getDocumentByUNID(String unid)
```
Opens a document in the database

Parameters:

unid - UNID of the document to retrieve

Returns:

an Optional describing the the document matching that ID, or an empty one if there is no such document

Throws:

DocumentDeletedException - if the document has been deleted

getDocumentByUNID
```
Optional<Document> getDocumentByUNID(String unid,
                                     Set<Database.OpenDocumentMode> flags)
```
Opens a document in the database

Parameters:

unid - the UNID of the document to retrieve

flags - the flags to control the document-opening mode

Returns:

an Optional describing the document matching that UNID, or an empty one if there is no such document

Throws:

DocumentDeletedException - if the document has been deleted

getDocumentByPrimaryKey
```
Optional<Document> getDocumentByPrimaryKey(String category,
                                           String objectId)
```
Uses an efficient NSF lookup mechanism to find a document that matches the primary key specified with category and objectKey.

Parameters:

category - category part of primary key

objectId - object id part of primary key

Returns:

an Optional describing the document matching that key, or an empty one if there is no such document

getAllDocumentsByPrimaryKey
```
Map<String,Map<String,Integer>> getAllDocumentsByPrimaryKey()
```
Returns the note id of all documents with assigned primary key (via Document.setPrimaryKey(String, String), hashed by their category value and object id

Returns:

case insensitive lookup result, outer map with category as hash key, inner map with [objectid,noteid] entries

getAllDocumentsByPrimaryKey
```
Map<String,Integer> getAllDocumentsByPrimaryKey(String category)
```
Returns the note id of all documents with category in the assigned primary key (via Document.setPrimaryKey(String, String), hashed by their category value and object id

Parameters:

category - category

Returns:

case insensitive result map with [objectid, noteid] entries

deleteDocument
```
void deleteDocument(int noteId)
```

deleteDocument
```
void deleteDocument(String unid)
```

deleteDocuments

void deleteDocuments(Collection<Integer> noteIds)

deleteDocumentsByUNID

void deleteDocumentsByUNID(Collection<String> unids)

createDocument
```
Document createDocument()
```

createDocument

Document createDocument(Set<Database.CreateFlags> flags)

getProfileDocument
```
Optional<Document> getProfileDocument(String profileName)
```
Parameters:

profileName - the name of the profile document to return

Returns:

an Optional describing the existing or new profile document, or an empty one if the document does not exist and cannot be created

getProfileDocument
```
Optional<Document> getProfileDocument(String profileName,
                                      String userName)
```
Parameters:

profileName - the name of the profile document to return

userName - the user name key for the profile instance

Returns:

an Optional describing the existing or new profile document, or an empty one if the document does not exist and cannot be created

forEachProfileDocument
```
void forEachProfileDocument(BiConsumer<Document,Loop> consumer)
```
Iterates over all profile documents in the database

Parameters:

consumer - consumer to receive documents

forEachProfileDocument
```
void forEachProfileDocument(String profileName,
                            BiConsumer<Document,Loop> consumer)
```
Iterates over all profile documents of the specified type in the database

Parameters:

profileName - profile name

consumer - consumer to receive documents

forEachProfileDocument

void forEachProfileDocument(String profileName,
                            String userName,
                            BiConsumer<Document,Loop> consumer)

Iterates over all profile documents of the specified type/username in the database

Parameters:: profileName - profile name; userName - username; consumer - consumer to receive documents

replicate
```
DominoClient.NotesReplicationStats replicate(String serverName)
```
Bidirectional replication of this database with another server

Parameters:

serverName - server to replicate with

Returns:

replication results

replicate

DominoClient.NotesReplicationStats replicate(String serverName,
                                             Set<Database.ReplicateOption> options,
                                             int timeLimitMin,
                                             DominoClient.ReplicationStateListener progressListener)

Replicate database with additional options

Parameters:: serverName - server to replicate with; options - replication options; timeLimitMin - If non-zero, number of minutes replication is allowed to execute before cancellation. If not specified, no limit is imposed; progressListener - optional listener to get notified about replication progress
Returns:: replication results

toUNID
```
String toUNID(int noteId)
```
Converts a single note ID to a UNID

Parameters:

noteId - note ID

Returns:

UNID or empty string if not found

toNoteId
```
int toNoteId(String unid)
```
Converts a single UNID to a note id

Parameters:

unid - UNID

Returns:

note id or 0 if not found

toUNIDs
```
void toUNIDs(Collection<Integer> noteIds,
             Map<Integer,String> resolvedUNIDsByNoteId,
             Set<Integer> unresolvedNoteIds)
```
Bulk conversion of note ids to UNIDs

Parameters:

noteIds - note ids to convert

resolvedUNIDsByNoteId - UNIDs for note ids that could be resolved

unresolvedNoteIds - set of note ids that could not be resolved

toNoteIds
```
void toNoteIds(Collection<String> unids,
               Map<String,Integer> resolvedNoteIDsByUNID,
               Set<String> unresolvedUNIDs)
```
Bulk conversion of UNIDs to note ids

Parameters:

unids - UNIDs to convert

resolvedNoteIDsByUNID - Note ids for UNIDs that could be resolved

unresolvedUNIDs - set of UNIDs that could not be resolved

isDocumentLockingEnabled
```
boolean isDocumentLockingEnabled()
```

setDocumentLockingEnabled

void setDocumentLockingEnabled(boolean b)

isLargeSummaryEnabled
```
boolean isLargeSummaryEnabled()
```

isFTIndex
```
boolean isFTIndex()
```

deleteFTIndex
```
void deleteFTIndex()
```
This function deletes a full text index and disables full text indexing for a database.

ftIndex
```
FTIndexStats ftIndex(Set<FTIndex> options)
```
This function creates a new full text index for a local database.

Synchronous full text indexing of a remote database is currently not supported. Use ftIndexRequest() to request an index update of a remote database.

Parameters:

options - Indexing options. See FTIndex

Returns:

indexing statistics

ftIndexRequest
```
void ftIndexRequest()
```
Requests an asynchronous update of the full text index

getLastFTIndexTime
```
Optional<DominoDateTime> getLastFTIndexTime()
```
This routine returns the last time a database was full text indexed. It can also be used to determine if a database is full text indexed.

Returns:

an Optional describing the last index time, or an empty one if the database has not been indexed

isLocallyEncrypted
```
boolean isLocallyEncrypted()
```
Determines whether the database is locally encrypted.
Note: this may be slightly more efficient than getLocalEncryptionInfo().

Returns:

true if the database is encrypted on disk; false otherwise

generateUNID
```
String generateUNID()
```

getCategories
```
String getCategories()
```

setCategories
```
void setCategories(String categories)
```

close
```
void close()
```
Closes the database, releasing its handle and allowing it to be deleted.
Calling this method will cause all future invocations of methods on this object to fail.

Specified by:

close in interface AutoCloseable

getMultiDocumentInfo
```
Database.DocInfo[] getMultiDocumentInfo(int[] noteIds)
```
This method can be used to get information for a number documents in a database from their note ids in a single call.
The data returned by this method is the note id, the UNID of the document, the sequence number and the sequence time ("Modified initially" time).

In addition, the method checks whether a document exists or has been deleted.

Parameters:

noteIds - array of note ids

Returns:

lookup results, same size and order as noteIds array

Throws:

IllegalArgumentException - if note id array has too many entries (more than 65535)

getMultiDocumentInfo
```
Database.DocInfo[] getMultiDocumentInfo(String[] noteUNIDs)
```
This method can be used to get information for a number documents in a database from their note unids in a single call.
The data returned by this method is the note id the UNID of the document, the sequence number and the sequence time ("Modified initially" time).

In addition, the method checks whether a document exists or has been deleted.

Parameters:

noteUNIDs - array of note unids

Returns:

lookup results, same size and order as noteUNIDs array

Throws:

IllegalArgumentException - if note unid array has too many entries (more than 32767)

getDocumentInfo

Database.DocInfoExt getDocumentInfo(int noteId)

getAgent
```
Optional<Agent> getAgent(String agentName)
```
Looks up and loads an agent in the database design

Parameters:

agentName - agent name

Returns:

an Optional describing the agent, or an empty one if no such agent can be found

getAgentSavedData
```
Optional<Document> getAgentSavedData(String agentName)
```
The returned document is created when you save an agent, and it is stored in the same database as the agent.
The document replicates, but is not displayed in views.
Each time you edit and re-save an agent, its saved data document is deleted and a new, blank one is created. When you delete an agent, its saved data document is deleted.

Parameters:

agentName - agent name

Returns:

an Optional describing the agent's saved data, or an empty one if no such agent can be found or if it has no saved data

getTemplateName
```
String getTemplateName()
```
The template name of a database, if the database is a template. If the database is not a template, returns an empty string.

Returns:

template name or "" if no template

setTemplateName
```
void setTemplateName(String newTemplateName)
```
Changes the template name of a template database.

Parameters:

newTemplateName - new template name

getDesignTemplateName
```
String getDesignTemplateName()
```
The name of the design template from which a database inherits its design.
If the database does not inherit its design from a design template, it returns an empty string ("").

Returns:

template name or ""

setDesignTemplateName
```
void setDesignTemplateName(String newDesignTemplateName)
```
Changes the name of the design template from which a database inherits its design

Parameters:

newDesignTemplateName - new design template name

queryFTIndex
```
FTQueryResult queryFTIndex(String query,
                           int maxResults,
                           Set<FTQuery> options,
                           Set<Integer> filterIds,
                           int start,
                           int count)
```
Performs a fulltext search in the database with advanced options.

Parameters:

query - fulltext query

maxResults - Maximum number of documents to return (max. 65535). Use 0 to return the maximum number of results for the search

options - search options

filterIds - optional ID table to further refine the search. Use null if this is not required.

start - the starting document number for the paged result. For the non-paged result, set this item to 0. For the paged result, set this item to a non-zero number.

count - number of documents to return for the paged result (max. 65535), set to 0 to return all results

Returns:

search result

updateDQLDesignCatalog
```
void updateDQLDesignCatalog(boolean rebuild)
```
Harvest view design elements for optimized DQL performance.

Parameters:

rebuild - true to rebuild the design catalog

queryDQL
```
DQLQueryResult queryDQL(DQL.DQLTerm query)
```
Runs a DQL query against the documents in the database.

Parameters:

query - Domino query (DQL) generated via DQL factory class

Returns:

query result

queryDQL
```
DQLQueryResult queryDQL(DQL.DQLTerm query,
                        Set<DBQuery> flags)
```
Runs a DQL query against the documents in the database.

Parameters:

query - Domino query (DQL) generated via DQL factory class

flags - controlling execution, see DBQuery

Returns:

query result

queryDQL
```
DQLQueryResult queryDQL(DQL.DQLTerm query,
                        Set<DBQuery> flags,
                        int maxDocsScanned,
                        int maxEntriesScanned,
                        int maxMsecs)
```
Runs a DQL query against the documents in the database.

Parameters:

query - Domino query (DQL) generated via DQL factory class

flags - controlling execution, see DBQuery

maxDocsScanned - maximum number of document scans allowed

maxEntriesScanned - maximum number of view entries processed allows

maxMsecs - max milliseconds of executiion allow

Returns:

query result

queryDQL
```
DQLQueryResult queryDQL(String query)
```
Runs a DQL query against the documents in the database.

Parameters:

query - Domino query (DQL) as a single string (max 64K in length)

Returns:

query result

queryDQL
```
DQLQueryResult queryDQL(String query,
                        Set<DBQuery> flags)
```
Runs a DQL query against the documents in the database.

Parameters:

query - Domino query (DQL) as a single string (max 64K in length)

flags - controlling execution, see DBQuery

Returns:

query result

queryDQL
```
DQLQueryResult queryDQL(String query,
                        Set<DBQuery> flags,
                        int maxDocsScanned,
                        int maxEntriesScanned,
                        int maxMsecs)
```
Runs a DQL query against the documents in the database.

Parameters:

query - Domino query (DQL) as a single string (max 64K in length)

flags - controlling execution, see DBQuery

maxDocsScanned - maximum number of document scans allowed

maxEntriesScanned - maximum number of view entries processed allows

maxMsecs - max milliseconds of execution allow

Returns:

query result

queryFormula
```
FormulaQueryResult queryFormula(String selectionFormula,
                                IDTable filter,
                                Set<DirectorySearchQuery.SearchFlag> searchFlags,
                                TemporalAccessor since,
                                Set<DocumentClass> docClass)
```
Evaluates a formula on a set of documents or the whole database

Parameters:

selectionFormula - selection formula

filter - optional filter IDTable to evaluate the formula only against selected documents

searchFlags - flags to control the search behavior

since - optional start date/time to run incremental searches, e.g. the value IDTable.getDateTime() of the returned FormulaQueryResult.getNoteIds()

docClass - class of documents to search

Returns:

query result

queryDocuments
```
DocumentSummaryQueryResult queryDocuments()
```
Runs an operation on all documents in the database

Returns:

query result, use DbQueryResult.computeValues(Map) to compute document values on the fly and DbQueryResult.sort(DominoCollection) to project the document note ids onto a DominoCollection to get them back sorted via DbQueryResult.collectEntries(int, int)

queryDocuments
```
DocumentSummaryQueryResult queryDocuments(Collection<Integer> ids)
```
Runs an operation on a number of documents in the database

Parameters:

ids - note ids of documents to process

Returns:

query result, use DbQueryResult.computeValues(Map) to compute document values on the fly and DbQueryResult.sort(DominoCollection) to project the document note ids onto a DominoCollection to get them back sorted via DbQueryResult.collectEntries(int, int)

queryFormula

DominoDateTime queryFormula(String selectionFormula,
                            Set<Integer> filter,
                            Set<DirectorySearchQuery.SearchFlag> searchFlags,
                            TemporalAccessor since,
                            Set<DocumentClass> docClass,
                            Map<String,String> computeValues,
                            Database.FormulaQueryCallback callback)

getAllNoteIds
```
IDTable getAllNoteIds(Set<DocumentClass> docClasses,
                      boolean includeDeletions)
```
This function returns an IDTable of all note IDs in the database with the given set of DocumentClass.

If includeDeletions is set to TRUE, the returned IDTable also contains the note IDs of deleted documents. Thoese note IDs are OR'ed with the special flag IDTable.NOTEID_FLAG_DELETED.

Use the date/time value returned by IDTable.getDateTime() as since parameter of getModifiedNoteIds(Set, TemporalAccessor, boolean) to incrementally read note id changes.

This function is just a convenience function and calls getModifiedNoteIds(Set, TemporalAccessor, boolean) with a since value of NULL.

Parameters:

docClasses - the appropriate DocumentClass mask for the documents you wish to select. Symbols can be OR'ed to obtain the desired Note classes in the resulting ID Table.

includeDeletions - true to include the note IDs of deleted docs

Returns:

IDTable

getModifiedNoteIds
```
IDTable getModifiedNoteIds(Set<DocumentClass> docClasses,
                           TemporalAccessor since,
                           boolean includeDeletions)
```
This function returns an IDTable of Note IDs of documents which have been modified in some way from the given starting time until "now".
The ending date/time is returned in IDTable.getDateTime(), so that this function can be performed incrementally.

The returned IDTable also contains the note IDs of deleted documents. These note IDs are bitwise OR'ed with the special flag IDTable.NOTEID_FLAG_DELETED.

Parameters:

docClasses - the appropriate DocumentClass mask for the documents you wish to select. Symbols can be OR'ed to obtain the desired Note classes in the resulting ID Table.

since - A date/time value containing the starting date used when selecting notes to be added to the ID Table built by this function. Use null to get all note ids.

includeDeletions - true to include the note IDs of deleted docs

Returns:

IDTable

findCollectionId
```
int findCollectionId(String name,
                     Database.CollectionType type)
```
Looks up a collection by name in the database design

Parameters:

name - name

type - type of collection to find

Returns:

note id of collection or 0 if not found

createFolder
```
int createFolder(String newFolderName)
```
Creates a new folder in the database with the default view/folder design

Parameters:

newFolderName - name of new folder

Returns:

note id of created folder

createFolder
```
int createFolder(String formatFolderName,
                 String newFolderName)
```
Creates a new folder in the database with the design of the specified folder/view

Parameters:

formatFolderName - name of folder/view to copy design

newFolderName - name of new folder

Returns:

note id of created folder

createFolder
```
int createFolder(int formatFolderNoteId,
                 String newFolderName)
```
Creates a new folder in the database with the design of the specified folder/view

Parameters:

formatFolderNoteId - note id of folder/view to copy design

newFolderName - name of new folder

Returns:

note id of created folder

createFolder
```
int createFolder(Database formatDb,
                 String formatFolderName,
                 String newFolderName)
```
Creates a new folder in the database with the design of the specified folder/view in another database

Parameters:

formatDb - database containing the folder design

formatFolderName - name of folder/view to copy design

newFolderName - name of new folder

Returns:

note id of created folder

createFolder
```
int createFolder(Database formatDb,
                 int formatFolderNoteId,
                 String newFolderName)
```
Creates a new folder in the database with the design of the specified folder/view in another database

Parameters:

formatDb - database containing the folder design

formatFolderNoteId - name of folder/view to copy design

newFolderName - name of new folder

Returns:

note id of created folder

deleteFolder
```
void deleteFolder(String folderName)
```
Deletes a folder

Parameters:

folderName - name of folder to delete

deleteFolder
```
void deleteFolder(int folderNoteId)
```
Deletes a folder

Parameters:

folderNoteId - note id of folder to delete

moveFolder
```
void moveFolder(String folderName,
                String newParentFolderName)
```
Moves a folder below another one

Parameters:

folderName - name of folder to move

newParentFolderName - new parent folder

moveFolder
```
void moveFolder(int folderNoteId,
                int newParentFolderNoteId)
```
Moves a folder below another one

Parameters:

folderNoteId - note id of folder to move

newParentFolderNoteId - new parent folder note id

renameFolder

void renameFolder(String oldFolderName,
                  String newFolderName)

Renames a folder

Parameters:: oldFolderName - old folder name; newFolderName - new folder name

renameFolder
```
void renameFolder(int oldFolderNoteId,
                  String newFolderName)
```
Renames a folder

Parameters:

oldFolderNoteId - note id of folder to rename

newFolderName - new folder name

copyFolder
```
int copyFolder(String sourceFolderName,
               String newFolderName)
```
Creates a copy of a folder including its content

Parameters:

sourceFolderName - name of folder to copy

newFolderName - name of new folder copy

Returns:

note id of copy

copyFolder
```
int copyFolder(int sourceFolderNoteId,
               String newFolderName)
```
Creates a copy of a folder including its content

Parameters:

sourceFolderNoteId - note id of folder to copy

newFolderName - name of new folder copy

Returns:

note id of copy

addToFolder

void addToFolder(String folderName,
                 Collection<Integer> noteIds)

Adds note ids to a folder

Parameters:: folderName - name of folder; noteIds - note ids to add

addToFolder
```
void addToFolder(int folderNoteId,
                 Collection<Integer> noteIds)
```
Adds note ids to a folder

Parameters:

folderNoteId - note id of folder

noteIds - note ids to add

removeFromFolder

void removeFromFolder(String folderName,
                      Collection<Integer> noteIds)

Removes note ids from a folder

Parameters:: folderName - name of folder; noteIds - note ids to remove

removeFromFolder

void removeFromFolder(int folderNoteId,
                      Collection<Integer> noteIds)

Removes note ids from a folder

Parameters:: folderNoteId - note id of folder; noteIds - note ids to remove

removeAllFromFolder
```
void removeAllFromFolder(int folderNoteId)
```
Removes all note ids from a folder

Parameters:

folderNoteId - note id of folder

removeAllFromFolder
```
void removeAllFromFolder(String folderName)
```
Removes all note ids from a folder

Parameters:

folderName - name of folder

getFolderDocCount
```
int getFolderDocCount(String folderName)
```
This function returns the number of entries in the specified folder's index.

This is the number of documents plus the number of categories (if any) in the folder.

Subfolders and documents in subfolders are not included in the count.

Parameters:

folderName - name of folder

Returns:

count

getFolderDocCount
```
int getFolderDocCount(int folderNoteId)
```
This function returns the number of entries in the specified folder's index.

This is the number of documents plus the number of categories (if any) in the folder.

Subfolders and documents in subfolders are not included in the count.

Parameters:

folderNoteId - note id of folder

Returns:

count

getIDTableForFolder
```
IDTable getIDTableForFolder(int folderNoteId,
                            boolean validateIds)
```
This function gets the Note IDs of notes in a folder and returns a IDTable.

Parameters:

folderNoteId - note id of folder

validateIds - If set, return only "validated" noteIDs

Returns:

id table

getIDTableForFolder
```
IDTable getIDTableForFolder(String folderName,
                            boolean validateIds)
```
This function gets the Note IDs of notes in a folder and returns a IDTable.

Parameters:

folderName - name of folder

validateIds - If set, return only "validated" noteIDs

Returns:

id table

getDesign
```
DbDesign getDesign()
```

getModifiedNotesInfo

Database.ModifiedNoteInfos getModifiedNotesInfo(Set<DocumentClass> docClasses,
                                                Set<Database.ModifiedNotesInfoFlags> infoRequested,
                                                TemporalAccessor sinceParam,
                                                boolean includeDeletions,
                                                TemporalAccessor optUntilParam)

Returns information about documents modified since the specified date/time

Parameters:: docClasses - document classes to scan, e.g. DocumentClass.DATA; infoRequested - controls what to return and how to filter; sinceParam - optional for incremental scans, use Database.ModifiedNoteInfos.getUntil() of a previous search; includeDeletions - true to return deletions; optUntilParam - if not null, optional upper date to return results
Returns:: scan result

getOptions
```
Set<DatabaseOption> getOptions()
```
Returns the DatabaseOption values for the database

Returns:

options

getOption
```
boolean getOption(DatabaseOption option)
```
Gets the value of a database option

Parameters:

option - set DatabaseOption

Returns:

true if the option is enabled, false if the option is disabled

setOption
```
void setOption(DatabaseOption option,
               boolean flag)
```
Sets the value of a database option

Parameters:

option - see DatabaseOption

flag - true to set the option

getUnreadDocumentTable
```
Optional<IDTable> getUnreadDocumentTable(String userName,
                                         boolean createIfNotAvailable,
                                         boolean updateUnread)
```
An ID Table is created containing the list of unread documents in the database for the specified user.

The argument createIfNotAvailable controls what action is to be performed if there is no list of unread notes for the specified user in the database.

If no list is found and this flag is set to false, the method will return null.
if this flag is set to {code true}, the list of unread documents will be created and all documents in the database will be added to the list.

No coordination is performed between different users of the same database.

If an application obtains a list of unread documents while another user is modifying the list, the changes made may not be visible to the application.

Unread marks for each user are stored in the client desktop.dsk file and in the database.

When a user closes a database (either through the Notes user interface or through an API program), the unread marks in the desktop.dsk file and in the database are synchronized so that they match.
Unread marks are not replicated when a database is replicated.

Instead, when a user opens a replica of a database, the unread marks from the desktop.dsk file propagates to the replica database.

Parameters:

userName - user for which to check unread marks (abbreviated or canonical format); use null for current DominoClient user

createIfNotAvailable - {code true}: If the unread list for this user cannot be found on disk, return all note IDs. false: If the list cannot be found, return null

updateUnread - true to update unread marks, false to not update unread marks.

Returns:

an Optional describing the table of unread documents, or an empty one if there is no table

updateUnreadDocumentTable
```
void updateUnreadDocumentTable(String userName,
                               Set<Integer> noteIdToMarkRead,
                               Set<Integer> noteIdsToMarkUnread)
```
Method to apply changes to the unread document table

Parameters:

userName - user for which to update unread marks (abbreviated or canonical format); use null for current DominoClient user

noteIdToMarkRead - note ids to mark read (=remove from the unread table)

noteIdsToMarkUnread - note ids to mark unread (=add to the unread table)

queryAccessRoles
```
List<String> queryAccessRoles(String userName)
```
Convenience method to look up the roles for a user from the database Acl.
Use Acl.lookupAccess(UserNamesList) if you need other access information for the same user as well.

Parameters:

userName - username, either canonical or abbreviated

Returns:

list of roles, not null

isDocumentUnread
```
boolean isDocumentUnread(String userName,
                         int noteId)
```
Checks if a document is in the unread table for the specified user.

For performance reasons we internally cache the unread table and store the username. This cached table is reused if the username on subsequent calls is the same and disposed if it is different.

Parameters:

userName - name if user in abbreviated or canonical format; if null, we use DominoClient.getEffectiveUserName()

noteId - note id of document

Returns:

true if unread

refreshDesign
```
void refreshDesign(String server)
```
This function will refresh the database design, as allowed by the database/design properties and access control of Domino, from a server's templates.

The refreshed database, if open in Domino or Notes at the time of refresh, must be closed and reopened to view any changes.

Convenience function that calls #refreshDesign(String, boolean, boolean, IBreakHandler) with force and errIfTemplateNotFound set to true and without break handler.

Parameters:

server - name of the Lotus Domino Server on which the database template resides, If you want to specify "no server" (the local machine), use ""

refreshDesign
```
void refreshDesign(String server,
                   boolean force,
                   boolean errIfTemplateNotFound,
                   DominoClient.IBreakHandler abortHandler)
```
This function will refresh the database design, as allowed by the database/design properties and access control of Domino, from a server's templates.

The refreshed database, if open in Domino or Notes at the time of refresh, must be closed and reopened to view any changes.

Parameters:

server - name of the Lotus Domino Server on which the database template resides, If you want to specify "no server" (the local machine), use ""

force - true to force operation, even if destination "up to date"

errIfTemplateNotFound - true to return an error if the template is not found

abortHandler - optional break handler to abort the operation or null

hardDeleteDocument
```
void hardDeleteDocument(int softDelNoteId)
```
This function permanently deletes the specified "soft deleted" document from the database.
The deleted document may be of any DocumentClass. The active user ID must have sufficient user access in the databases's Access Control List (ACL) to carry out a deletion on the document or the function will throw an error.

Parameters:

softDelNoteId - The note ID of the document that you want to delete

getModifiedTime
```
void getModifiedTime(Ref<DominoDateTime> retDataModified,
                     Ref<DominoDateTime> retNonDataModified)
```
This function obtains the date/time of the last modified data and non-data documents in the specified database.

Parameters:

retDataModified - will be filled with the last modified date/time of data documents

retNonDataModified - will be filled with the last modified date/time of non-data (design) documents

generateOID
```
DominoOriginatorId generateOID()
```
This function generates a new Originator ID (OID) used to uniquely identify a document.

Use this function when you already have a document open and wish to create a totally new document with the same items as the open document.

You do not need this method when creating a new note from scratch using createDocument(), because the OID is already generated for you.

If the database resides on a remote Lotus Domino Server, the current user must to have the appropriate level of access to carry out this operation.

Returns:

new OID

reopen
```
Database reopen()
```
Re-opens the database with a new handle.
This can be useful for additional safely when working with the same database across multiple threads.

Returns:

a new Database instance for the current database

Since:

1.0.9

getItemDefinitionTable
```
NavigableMap<String,ItemDataType> getItemDefinitionTable()
```
The extended version of the Item Definition Table for a database contains the number of items, name and type of all the items defined in that database.

Examples are field names, form names, design names, and formula labels.
Applications can obtain a copy of the extended version of the Item Definition Table by calling this method.

Returns:

item definition table with item names as keys (case-insensitive and sorted) and item type as value

createDocumentSelection
```
DocumentSelection createDocumentSelection()
```
Creates a new DocumentSelection to select data or design documents.

Returns:

selection

createQueryResultsProcessor
```
QueryResultsProcessor createQueryResultsProcessor()
```
Creates a QueryResultsProcessor to process the results of multi-database queries

Returns:

query results processor

getLocalEncryptionInfo
```
Database.EncryptionInfo getLocalEncryptionInfo()
```
Returns:

the current status of the database's local encryption.

Since:

1.0.18

getEffectiveAccessInfo
```
Database.AccessInfo getEffectiveAccessInfo()
```
Retrieves the current effective access level and flags for the open database.

Returns:

an Database.AccessInfo object describing the current access

getNSFVersionInfo

Database.NSFVersionInfo getNSFVersionInfo()

Reads information about the On-Disk-Structure (ODS) of the database. Each release of Domino or Notes software can access databases that have a major version number that is less than or equal to a particular value associated with that release.

A Domino database that has a major version number that is greater than the major version number associated with a particular Domino or Notes release cannot be accessed by that release.

The following table shows which major version numbers can be accessed by particular releases of Domino or Notes:

Domino or Notes Software Releases	Major Version Numbers That Can Be Accessed
1.x	16
2.x	16
3.x	17
4.0, 4.1, 4.5.x, 4.6.x	20 or less
5.0 - 5.0.12, 6 - 6.0.3, 6.5, 7.0	43 or less
9.0	52
10.x - 11.x	53
12.0.0	54

Returns:: ODS info

getBuildVersionInfo
```
BuildVersionInfo getBuildVersionInfo()
```
This function returns a BuildVersionInfo object which contains all types of information about the level of code running on a machine.

See BuildVersionInfo for more information.

Returns:

version

getNamesList
```
Optional<UserNamesList> getNamesList()
```
This function returns a UserNamesList structure. Result is empty when the database was opened as the ID user.

Returns:

names list if present

Interface Database

Nested Class Summary

Method Summary

Methods inherited from interface com.hcl.domino.data.IAdaptable

Methods inherited from interface com.hcl.domino.misc.DominoClientDescendant

Method Detail

getServer

getRelativeFilePath

getAbsoluteFilePath

getReplicaID

getTitle

setTitle

isRemote

hasFullAccess

getACL

openCollection

openCollectionByUNID

openDefaultCollection

openDesignCollection

forEachCollection

getAllCollections

getDocumentById

getDocumentById

getSoftDeletedDocumentById

getSoftDeletedDocumentByUNID

getDocumentByUNID

getDocumentByUNID

getDocumentByPrimaryKey

getAllDocumentsByPrimaryKey

getAllDocumentsByPrimaryKey

deleteDocument

deleteDocument

deleteDocuments

deleteDocumentsByUNID

createDocument

createDocument

getProfileDocument

getProfileDocument

forEachProfileDocument

forEachProfileDocument

forEachProfileDocument

replicate

replicate

toUNID

toNoteId

toUNIDs

toNoteIds

isDocumentLockingEnabled

setDocumentLockingEnabled

isLargeSummaryEnabled

isFTIndex

deleteFTIndex

ftIndex

ftIndexRequest

getLastFTIndexTime

isLocallyEncrypted

generateUNID

getCategories

setCategories

close

getMultiDocumentInfo

getMultiDocumentInfo

getDocumentInfo

getAgent

getAgentSavedData

getTemplateName

setTemplateName

getDesignTemplateName

setDesignTemplateName

queryFTIndex

updateDQLDesignCatalog

queryDQL

queryDQL

queryDQL

queryDQL

queryDQL

queryDQL

queryFormula

queryDocuments

queryDocuments