| Modifier and Type | Method and Description |
|---|---|
Database |
DominoClient.createDatabase(String serverName,
String filePath,
boolean forceCreation,
boolean initDesign,
DominoClient.Encryption encryption)
Creates a new database on the target server with a given file path.
|
Database |
DominoClient.createDatabase(String serverName,
String filePath,
boolean forceCreation,
boolean initDesign,
DominoClient.Encryption encryption,
DatabaseClass dbClass)
Creates a new database on the target server with a given file path.
|
Database |
DominoClient.createDatabaseFromTemplate(String sourceServerName,
String sourceFilePath,
String targetServerName,
String targetFilePath,
DominoClient.Encryption encryption)
Creates a new database from the specified template DB.
|
Database |
DominoClient.createDatabaseReplica(String sourceServerName,
String sourceFilePath,
String targetServerName,
String targetFilePath,
DominoClient.Encryption encryption)
Creates a new database replica, which is a new database with copied design/data documents
and the same replica ID as the specified DB.
|
Database |
DominoClient.openDatabase(String path)
Opens a database by path.
|
Database |
DominoClient.openDatabase(String path,
Set<DominoClient.OpenDatabase> options)
Opens a database by path.
|
Database |
DominoClient.openDatabase(String serverName,
String filePath)
Opens a database.
|
Database |
DominoClient.openDatabase(String serverName,
String filePath,
Set<DominoClient.OpenDatabase> options)
Opens a database with options if database is not accessible.
|
| Modifier and Type | Method and Description |
|---|---|
Optional<Database> |
DominoClient.openMailDatabase()
Opens the mail database if the current user
|
Optional<Database> |
DominoClient.openMailDatabase(Set<DominoClient.OpenDatabase> options)
Opens the mail database if the current user
|
| Modifier and Type | Method and Description |
|---|---|
Database |
ReplicaInfo.getParentDatabase()
Returns the database this replica info belongs to
|
| Modifier and Type | Method and Description |
|---|---|
void |
Replication.clearReplicationHistory(Database db)
Resets the replication history of a database so enforce a full replication
|
void |
Replication.getDocuments(Database db,
int[] noteIds,
Set<Database.OpenDocumentMode>[] docOpenFlags,
int[] sinceSeqNum,
Set<GetDocumentsMode> controlFlags,
Database objectDb,
Replication.IGetDocumentsCallback getDocumentsCallback,
Replication.IDocumentOpenCallback docOpenCallback,
Replication.IObjectAllocCallback objectAllocCallback,
Replication.IObjectWriteCallback objectWriteCallback,
TemporalAccessor folderSinceTime,
Replication.IFolderAddCallback folderAddCallback)
This function will return a stream of documents to the caller through several callback functions.
It can be used to quickly and incrementally read a large number of docs from a database, skipping the transfer of item values where the item's sequence number is lower or equal a specified value (see sinceSeqNum parameter). |
ReplicaInfo |
Replication.getReplicaInfo(Database db)
This function gets the given database's
ReplicaInfo structure.This structure contains information that tells the Domino Replicator how to treat the database. The ".ID" member enables the Replicator to identify "replicas" of databases. The ".CutoffInterval" is the age in days at which deleted document identifiers are purged. Domino divides this interval into thirds, and for each third of the interval carries out what amounts to an incremental purge. These deleted document identifiers are sometimes called deletion stubs. The ".Cutoff" member is a DominoDateTime value that is calculated by
subtracting the Cutoff Interval (also called Purge Interval) from today's date.It prevents notes that are older than that date from being replicated at all. The ".Flags" member is a bit-wise encoded short that stores miscellaneous Replicator flags. |
List<ReplicationHistorySummary> |
Replication.getReplicationHistory(Database db,
Set<Replication.ReplicationHistoryFlags> flags)
Reads the replication history of the database
|
String |
Replication.setNewReplicaID(Database db)
Changes the replica id of a database
|
void |
Replication.setReplicaInfo(Database db,
ReplicaInfo replicaInfo)
This function sets the given database's
ReplicaInfo structure.Use this function to set specific values, such as the replica ID, in the header data of a database. You may also use Replication.setReplicaInfo(Database, ReplicaInfo) to set values
such as the replication flags in the header of the database. |
| Modifier and Type | Method and Description |
|---|---|
String |
Calendaring.createCalendarEntry(Database dbMail,
String iCal,
Collection<CalendarWrite> flags)
Creates a calendar entry.
This supports either a single entry, or a recurring entry which may contain multiple VEVENTS represenging both the series and exception data. |
void |
Calendaring.entryAction(Database dbMail,
String uid,
String recurId,
Collection<CalendarProcess> action,
CalendarRangeRepeat scope,
String comment,
CalendarActionData data,
Collection<CalendarActionOptions> flags)
Perform an action on a calendar entry.
For instance, change the response of an accepted meeting to counter or delegate. This must be applied to meetings (with the exception of CalendarProcess.DELETE,
which can be applied to any calendar entry).This makes the appropriate modifications to the invitee calendar and also sends appropriate notices out. |
int |
Calendaring.getNewInvitations(Database dbMail,
TemporalAccessor start,
String uid,
TemporalAccessor since,
AtomicReference<DominoDateTime> retUntil,
List<Integer> retNoteIds,
List<String> retUNIDs)
Retrieve invitations in a mailfile that have not yet been responded to.
This returns the number of new invitations as well as optional NOTEID and/or UNID lists. This returns only invitations (and delegated invitations), and not reschedules, information updates, cancels, etc. This method does not filter out any invitations that have since been canceled/rescheduled, or are otherwise out of date. Once the invitation is accepted, other notices that apply to that meeting can be discovered with a call to Calendaring.getUnappliedNotices(Database, String, List, List)
must be used (on a per-UID level).Only invitations for meetings that are current (at least one instance starts within the last day or in the future) are returned, although the starting time can be specified by the caller to override the default.A caller can retrieve only invitations that have arrived since a prior call to Calendaring.getNewInvitations(com.hcl.domino.data.Database, java.time.temporal.TemporalAccessor, java.lang.String, java.time.temporal.TemporalAccessor, java.util.concurrent.atomic.AtomicReference<com.hcl.domino.data.DominoDateTime>, java.util.List<java.lang.Integer>, java.util.List<java.lang.String>)
by using tdSince and ptdretUntil.If uid is provided, invitations only for a
particular meeting will be returned.This is useful if you are looking for an invitation or invitations that correspond to an updated notice that has arrived. Note: Multiple invitations might exist for a particular UID if that meeting is recurring and you were added to an instance or instances after the initial creation. The returned notices are not guaranteed to be in any particular order. |
String |
Calendaring.getUIDfromNoteID(Database dbMail,
int noteId)
This is a convinience method that returns a UID from a NOTEID.
NOTEID->UID is a many to one mapping since one or several notes may represent a calendar entry (especially if it repeats) and its related notices. |
String |
Calendaring.getUIDFromUNID(Database dbMail,
String unid)
This is a convinience method that returns a UID from a UNID.
UNID->UID is a many to one mapping since one or several notes may represent a calendar entry (especially if it repeats) and its related notices. As such, the UID output will be the same for all notes that refer to the same calendar entry. This method may incur a note open, so there could be performance impact. |
int |
Calendaring.getUnappliedNotices(Database dbMail,
String uid,
List<Integer> retNoteIds,
List<String> retUNIDs)
Retrieve the unapplied notices that exist for a participant of calendar entry representing a meeting.
This will return things like: Reschedules, informational updates, cancelations, confirmations, etc. Notices will only be returned if the initial invitation has already been responded to, otherwise this method will return ERR_INVITE_NOT_ACCEPTED. For recurring meetings, notices that apply to any instances in the series will be returned, with the exception of instances where the initial invitation has not yet been responded to. Calendar entries that are not meetings will return ERR_INVALID_NOTE. We do not currently support getting unprocessed calendar entries if you are the owner (such as a counter proposal request or a request for updated information), so this will return ERR_NOT_YET_IMPLEMENTED. Note: For recurring meetings, it is possible that multiple notices will contain current information for a particular occurence, so it is not possible to guarantee that there is a single "most current" notice. For example, the subject might be changed for a single instance, and then the time may be changed across instances. Because only one notice will have the current subject and another notice will have the current time but NOT the current subject, both notices will be returned and both must be processed to guarantee accuracy. Process returned notices via the CalNoticeAction method. |
void |
Calendaring.noticeAction(Database dbMail,
int noteId,
Collection<CalendarProcess> action,
String comment,
CalendarActionData data,
Collection<CalendarActionOptions> flags)
Process a calendar notice.
This makes the appropriate modifications to the calendar entry and also sends appropriate notices out. |
void |
Calendaring.noticeAction(Database dbMail,
String unid,
Collection<CalendarProcess> action,
String comment,
CalendarActionData data,
Collection<CalendarActionOptions> flags)
Process a calendar notice.
This makes the appropriate modifications to the calendar entry and also sends appropriate notices out. |
Document |
Calendaring.openCalendarEntryDocument(Database dbMail,
String uid,
String recurId,
Collection<CalendarDocumentOpen> flags)
This is a method to get a document for an entry on the calendar.
The intent is that the note handle can be used to get information about an entry or instance or to write additional information to the entry or instance (beyond what is defined in iCalendar and/or available in this API). |
String |
Calendaring.readCalendarEntry(Database dbMail,
String uid,
String recurId,
Collection<CalendarRead> flags)
This will return complete iCalendar data for the specified entry.
For recurring entries, this may result in multiple VEVENTs in the returned iCalendar data. In this case, the first VEVENT represents the recurrence set and additional entries represent exceptions to the recurrence set. All instances that differ from the recurrence set will be returned as additional VEVENTs containing the exceptional data. |
String |
Calendaring.readNotice(Database dbMail,
int noteId,
Collection<CalendarRead> flags)
This will return iCalendar data representing a notice with the specified NOTIED.
A notice may not yet be applied to the calendar entries itself, but an application may want to read the notice (and process it). Examples of notices include invitations, reschedules, information updates, confirmations, cancelations, counterproposals, requests for information, acceptances, declines, tenative acceptances, etc. |
String |
Calendaring.readNotice(Database dbMail,
String unid,
Collection<CalendarRead> flags)
This will return iCalendar data representing a notice with the specified NOTIED.
A notice may not yet be applied to the calendar entries itself, but an application may want to read the notice (and process it). Examples of notices include invitations, reschedules, information updates, confirmations, cancelations, counterproposals, requests for information, acceptances, declines, tenative acceptances, etc. |
void |
Calendaring.readRange(Database dbMail,
TemporalAccessor start,
TemporalAccessor end,
Appendable retICal,
List<String> retUIDs)
Gets a summary of calendar entries for a range of times
|
void |
Calendaring.readRange(Database dbMail,
TemporalAccessor start,
TemporalAccessor end,
int skipCount,
int maxRead,
Appendable retICal,
List<String> retUIDs)
Gets a summary of calendar entries for a range of times
|
void |
Calendaring.readRange(Database dbMail,
TemporalAccessor start,
TemporalAccessor end,
int skipCount,
int maxRead,
Collection<CalendarReadRange> readMask,
Appendable retICal,
List<String> retUIDs)
Gets a summary of calendar entries for a range of times
|
void |
Calendaring.updateCalendarEntry(Database dbMail,
String iCal,
String uid,
String recurId,
String comments,
Collection<CalendarWrite> flags)
This will modify an existing calendar entry.
This supports either single entries or recurring entries, but recurring entries will only support updates for a single instance specified via RECURRENCE-ID that may not include a RANGE (This may be permitted in the future but for now will return an error). The iCalendar input may only contain a single VEVENT and must contain a UID. By default, attachments and custom data (for fields contained in $CSCopyItems) will be maintained from the existing calendar entry. |
| Modifier and Type | Method and Description |
|---|---|
Database |
DominoCollectionInfo.getParent() |
Database |
DocumentSelection.getParentDatabase()
Returns the parent database
|
Database |
Agent.getParentDatabase()
Database containing the agent
|
Database |
DominoCollection.getParentDatabase() |
Database |
Document.getParentDatabase()
Retrieves the parent database of this document.
|
Database |
DbQueryResult.getParentDatabase()
Returns the
Database that was used to run the query |
Database |
Database.reopen()
Re-opens the database with a new handle.
|
| Modifier and Type | Method and Description |
|---|---|
Document |
Document.copyToDatabase(Database otherDb)
Copies the document to another database.
|
int |
Database.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 |
Database.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
|
Database.Action |
Database.FormulaQueryCallback.deletionFound(Database db,
Database.SearchMatch searchMatch,
TypedAccess computedValues) |
Database.Action |
Database.FormulaQueryCallback.matchFound(Database db,
Database.SearchMatch searchMatch,
TypedAccess computedValues) |
Database.Action |
Database.FormulaQueryCallback.nonMatchFound(Database db,
Database.SearchMatch searchMatch,
TypedAccess computedValues) |
| Modifier and Type | Method and Description |
|---|---|
DbDesign |
DbDesignCatalog.readDatabaseDesign(Database db) |
void |
DbDesignCatalog.refreshDesign(Database db,
String serverWithTemplate)
Refresh the design of a database
|
void |
DbDesignCatalog.refreshDesign(Database db,
String serverWithTemplate,
boolean force,
boolean errIfTemplateNotFound,
DbDesignCatalog.DesignRefreshBreakHandler breakHandler)
Refresh the design of a database with advanced options
|
| Modifier and Type | Method and Description |
|---|---|
void |
QueryResultsProcessor.addNoteIds(Database parentDb,
Collection<Integer> noteIds,
String resultsname)
Adds note ids from a database to the query results processor
|
| Modifier and Type | Method and Description |
|---|---|
default void |
DxlExporter.exportACL(Database db,
OutputStream out)
Export the ACL of the specified database in XML format.
|
void |
DxlExporter.exportACL(Database db,
Writer out)
Export the ACL of the specified database in XML format.
|
default void |
DxlExporter.exportDatabase(Database db,
OutputStream out)
Export an entire database in XML format.
|
void |
DxlExporter.exportDatabase(Database db,
Writer out)
Export an entire database in XML format.
|
default void |
DxlExporter.exportIDs(Database db,
Collection<Integer> ids,
OutputStream out)
Export a set of note ids into XML format.
|
void |
DxlExporter.exportIDs(Database db,
Collection<Integer> ids,
Writer out)
Export a set of note ids into XML format.
|
void |
DxlImporter.importDxl(InputStream in,
Database db) |
default void |
DxlImporter.importDxl(Reader in,
Database db) |
default void |
DxlImporter.importDxl(String dxl,
Database db) |
default void |
DxlImporter.importDxlFromACLExporter(Database dbSource,
DxlExporter exporter,
Database dbTarget,
OutputStream debugExportOut) |
default void |
DxlImporter.importDxlFromDBExporter(Database dbSource,
DxlExporter exporter,
Database dbTarget,
OutputStream debugExportOut) |
default void |
DxlImporter.importDxlFromIDExporter(Database dbSource,
Collection<Integer> ids,
DxlExporter exporter,
Database dbTarget,
OutputStream debugExportOut) |
| Modifier and Type | Method and Description |
|---|---|
RichTextHTMLConverter.Builder |
RichTextHTMLConverter.render(Database database)
Renders a database as HTML, which displays its web landing page.
|
| Modifier and Type | Method and Description |
|---|---|
JsonDeserializer |
JsonDeserializer.target(Database database)
Sets the deserialization target to be a new document in the target database.
|
| Modifier and Type | Method and Description |
|---|---|
OutOfOffice |
Person.openOutOfOffice(String homeMailServer,
boolean isHomeMailServer,
Database dbMail)
Opens the out of office information for the user with read/write access
|
| Modifier and Type | Method and Description |
|---|---|
RichTextWriter |
RichTextWriter.addDatabaseLink(Database db,
String comment)
This function inserts a DocLink for the specified
Database. |
Copyright © 2019–2021 HCL. All rights reserved.