Uses of Interface
com.hcl.domino.data.Document

Packages that use Document

Package	Description
com.hcl.domino.admin.replication
com.hcl.domino.calendar
com.hcl.domino.data
com.hcl.domino.design
com.hcl.domino.dxl
com.hcl.domino.html
com.hcl.domino.json
com.hcl.domino.mime
com.hcl.domino.richtext
com.hcl.domino.security

Uses of Document in com.hcl.domino.admin.replication

Methods in com.hcl.domino.admin.replication with parameters of type Document

Modifier and Type	Method and Description
Replication.Action	Replication.IDocumentOpenCallback.documentOpened(Document doc, int noteId, Optional<DominoException> status) Called for each document retrieved
Replication.Action	Replication.IObjectAllocCallback.objectAllocated(Document doc, int oldRRV, Optional<DominoException> status, int objectSize) Called exactly once for each object to provide the caller with information about the object's size and ObjectID
Replication.Action	Replication.IObjectWriteCallback.objectChunkWritten(Document doc, int oldRRV, Optional<DominoException> status, ByteBuffer buffer, int bufferSize) Called for each "chunk" of each object
void	Replication.saveDocument(Document doc, boolean force, boolean noRevisionHistory, boolean keepModTime) Saves a document with additional flags

Uses of Document in com.hcl.domino.calendar

Methods in com.hcl.domino.calendar that return Document

Modifier and Type

Method and Description

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).

Methods in com.hcl.domino.calendar with parameters of type Document

Modifier and Type	Method and Description
String	Calendaring.getUIDfromDocument(Document document) This is a convinience method that returns a UID for a calendar entry document. NOTEID->UID is a many to one mapping since one or several documents may represent a calendar entry (especially if it repeats) and its related notices.

Uses of Document in com.hcl.domino.data

Subinterfaces of Document in com.hcl.domino.data

Modifier and Type	Interface and Description
interface	AutoCloseableDocument

Methods in com.hcl.domino.data that return Document

Modifier and Type	Method and Description
Document	Document.appendItemValue(String itemName, Object value) Appends an item value to the document, leaving any other items of the same name in place.
Document	Document.appendItemValue(String itemName, Set<Item.ItemFlag> flags, Object value) Appends an item value to the document, leaving any other items of the same name in place.
Document	Document.appendItemValue(String itemName, Set<Item.ItemFlag> flags, Object value, boolean allowDataTypeChanges) Appends an item value to the document, leaving any other items of the same name in place.
Document	Document.copyAndEncrypt(UserId id, Collection<Document.EncryptionMode> encryptionMode) This function copies and encrypts (seals) the encryption enabled fields in a document (including the document's file objects), using a UserId. It can encrypt a document in several ways -- by using the Domino public key of the caller, by using specified secret encryption keys stored in the caller's ID, or by using the Domino public keys of specified users, if the document does not have any mime parts. The method decides which type of encryption to do based upon the setting of the flag passed to it in its encryptionMode argument. If the Document.EncryptionMode.ENCRYPT_WITH_USER_PUBLIC_KEY flag is set, it uses the caller's public ID to encrypt the document. In this case, only the user who encodes the document can decrypt it. This feature allows an individual to protect information from anyone else. If, instead, the Document.EncryptionMode.ENCRYPT_WITH_USER_PUBLIC_KEY flag is not set, then the function expects the document to contain a field named "SecretEncryptionKeys" a field named "PublicEncryptionKeys", or both. Each field is either a ItemDataType.TYPE_TEXT or ItemDataType.TYPE_TEXT_LIST field. "SecretEncryptionKeys" contains the name(s) of the secret encryption keys in the calling user's ID to be used to encrypt the document. This feature is intended to allow a group to encrypt some of the documents in a single database in a way that only they can decrypt them -- they must share the secret encryption keys among themselves first for this to work. "PublicEncryptionKeys" contains the name(s) of users, in canonical format. The document will be encrypted with each user's Domino public key. The user can then decrypt the document with the private key in the user's ID. This feature provides a way to encrypt documents, such as mail documents, for another user. The document must contain at least one encryption enabled item (an item with the Item.ItemFlag.ENCRYPTED flag set) in order to be encrypted. If the note has mime parts and flag Document.EncryptionMode.ENCRYPT_SMIME_IF_MIME_PRESENT is set, then it is SMIME encrypted. If the document is to be signed as well as encrypted, you must sign the document before using this method.
Document	Document.copyToDatabase(Database otherDb) Copies the document to another database.
Document	Database.createDocument()
Document	Database.createDocument(Set<Database.CreateFlags> flags)
Document	Attachment.getParent() Returns the parent document of this attachment
Document	Document.replaceItemValue(String itemName, Object value) Sets the value of an item value to the document, replacing any other items of the same name.
Document	Document.replaceItemValue(String itemName, Object value, boolean allowDataTypeChanges) Sets the value of an item value to the document, replacing any other items of the same name.
Document	Document.replaceItemValue(String itemName, Set<Item.ItemFlag> flags, Object value) Sets the value of an item value to the document, replacing any other items of the same name.
Document	Document.replaceItemValue(String itemName, Set<Item.ItemFlag> flags, Object value, boolean allowDataTypeChanges) Sets the value of an item value to the document, replacing any other items of the same name.
Document	Document.setDocumentClass(DocumentClass docClass) Sets the class of this document.

Methods in com.hcl.domino.data that return types with arguments of type Document

Modifier and Type	Method and Description
Optional<Document>	Agent.getAgentSavedData() 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.
Optional<Document>	Database.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.
Optional<Document>	Database.getDocumentById(int noteId) Opens a document in the database
Optional<Document>	Database.getDocumentById(int noteId, Set<Database.OpenDocumentMode> flags) Opens a document in the database
Optional<Document>	Database.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>	Database.getDocumentByUNID(String unid) Opens a document in the database
Optional<Document>	Database.getDocumentByUNID(String unid, Set<Database.OpenDocumentMode> flags) Opens a document in the database
Optional<Document>	Agent.AgentRunContext.getDocumentContext() Returns the Document for Session.DocumentContext as a Document
Stream<Document>	DbQueryResult.getDocuments()
Optional<Document>	Database.getProfileDocument(String profileName)
Optional<Document>	Database.getProfileDocument(String profileName, String userName)
Optional<Document>	Database.getSoftDeletedDocumentById(int noteId) Opens a soft deleted document in the database
Optional<Document>	Database.getSoftDeletedDocumentByUNID(String unid) Opens a soft deleted document in the database
Optional<Document>	CollectionEntry.openDocument() Open the database document for this collection entry

Methods in com.hcl.domino.data with parameters of type Document

Modifier and Type	Method and Description
boolean	Document.convertRichTextItem(String itemName, Document targetNote, String targetItemName, IRichTextConversion... conversions) Applies one of multiple conversions to a rich text item, writing the new version in the target document and item.
void	Item.copyToDocument(Document doc, boolean overwrite) Copies this item to a new document, retaining the current name.
void	Item.copyToDocument(Document doc, String newItemName, boolean overwrite) Copies this item to a new document, with a new Item name.
List<Object>	Formula.evaluate(Document doc) Runs a formula on a document
Double	Formula.evaluateAsNumber(Document doc, Double defaultValue) Runs a formula on a document and converts the result to a number
String	Formula.evaluateAsString(Document doc) Runs a formula on a document and converts the result to a string
Formula.FormulaExecutionResult	Formula.evaluateExt(Document doc) Formula execution that returns more information about the computation result
void	Document.makeResponse(Document doc) Makes the document a response to another document.
Agent.AgentRunContext	Agent.AgentRunContext.setDocumentContext(Document doc) Sets the Document for Session.DocumentContext as a Document.

Method parameters in com.hcl.domino.data with type arguments of type Document

Modifier and Type	Method and Description
void	DominoCollection.forEachDocument(int skip, int count, BiConsumer<Document,Loop> consumer)
void	CollectionSearchQuery.forEachDocument(int skip, int count, BiConsumer<Document,Loop> consumer)
void	DbQueryResult.forEachDocument(int skip, int count, BiConsumer<Document,Loop> consumer) Iterates over each document in the search result
void	Database.forEachProfileDocument(BiConsumer<Document,Loop> consumer) Iterates over all profile documents in the database
void	Database.forEachProfileDocument(String profileName, BiConsumer<Document,Loop> consumer) Iterates over all profile documents of the specified type in the database
void	Database.forEachProfileDocument(String profileName, String userName, BiConsumer<Document,Loop> consumer) Iterates over all profile documents of the specified type/username in the database

Uses of Document in com.hcl.domino.design

Methods in com.hcl.domino.design that return Document

Modifier and Type	Method and Description
Document	DesignElement.getDocument()

Uses of Document in com.hcl.domino.dxl

Methods in com.hcl.domino.dxl with parameters of type Document

Modifier and Type	Method and Description
default void	DxlExporter.exportDocument(Document doc, OutputStream out) Export a single document into XML format.
void	DxlExporter.exportDocument(Document doc, Writer out) Export a single document into XML format.

Uses of Document in com.hcl.domino.html

Methods in com.hcl.domino.html with parameters of type Document

Modifier and Type	Method and Description
void	RichTextHTMLConverter.readEmbeddedImage(Document doc, String itemName, Collection<String> options, int itemIndex, int itemOffset, EmbeddedImage.HTMLImageReader callback) Method to access images embedded in HTML conversion result.
RichTextHTMLConverter.Builder	RichTextHTMLConverter.render(Document doc) Renders a document as HTML (including its form) and gives access to embedded images.
RichTextHTMLConverter.Builder	RichTextHTMLConverter.renderItem(Document doc, String itemName) Renders a rich text item as HTML and gives access to embedded images

Uses of Document in com.hcl.domino.json

Methods in com.hcl.domino.json that return Document

Modifier and Type	Method and Description
default Document	JsonDeserializer.fromJson(Object json) Deserializes the provided implementation-specific JSON object into a document.
Document	JsonDeserializer.fromJson(String json) Deserializes the provided JSON object string into a document.

Methods in com.hcl.domino.json with parameters of type Document

Modifier and Type	Method and Description
JsonDeserializer	JsonDeserializer.target(Document document) Sets the deserialization target to be an existing document in the target database.
Object	JsonSerializer.toJson(Document doc) Serializes the provided document as a JSON object using the implementation's native JSON type.
default String	JsonSerializer.toJsonString(Document doc) Serializes the provided document as a JSON string.

Uses of Document in com.hcl.domino.mime

Methods in com.hcl.domino.mime with parameters of type Document

Modifier and Type	Method and Description
void	MimeWriter.convertToMime(Document doc, RichTextMimeConversionSettings convertSettings) This function converts all rich text items (type ItemDataType.TYPE_COMPOSITE) in the document to MIME items (type ItemDataType.TYPE_MIME_PART). It does not update the database; to update the database, save the document.
Reader	MimeReader.getMIMEReader(Document doc, String itemName, Set<MimeReader.ReadMimeDataType> dataType) Returns a Reader to read the MIME content
jakarta.mail.internet.MimeMessage	MimeReader.readMIME(Document doc, String itemName, Set<MimeReader.ReadMimeDataType> dataType) Reads MIME content from a document and returns it as a MimeMessage.
void	MimeReader.readMIME(Document doc, String itemName, Set<MimeReader.ReadMimeDataType> dataType, Writer targetWriter) Reads MIME content from a document into a Writer in a streaming fashion.
void	MimeWriter.writeMime(Document doc, String itemName, jakarta.mail.Message mimeMessage, Set<MimeWriter.WriteMimeDataType> dataType) Writes the content of a Message to a document.
void	MimeWriter.writeMime(Document doc, String itemName, Reader reader, Set<MimeWriter.WriteMimeDataType> dataType) Writes raw MIME content to a document.

Uses of Document in com.hcl.domino.richtext

Methods in com.hcl.domino.richtext that return Document

Modifier and Type	Method and Description
Document	RichTextWriter.getParentDocument() Returns the document that will contain the rich text data

Methods in com.hcl.domino.richtext with parameters of type Document

Modifier and Type	Method and Description
RichTextWriter	RichTextWriter.addDocLink(Document doc, String comment) This function inserts a DocLink for the specified Document.
RichTextWriter	RichTextWriter.addRichText(Document doc, String itemName) Appends a rich text item from another document

Uses of Document in com.hcl.domino.security

Methods in com.hcl.domino.security with parameters of type Document

Modifier and Type	Method and Description
Set<ECLCapability>	Ecl.trustSignerOfDocument(Document doc, DominoClient.ECLType type, Collection<ECLCapability> capabilities, boolean sessionOnly) Method to modify the ECL for the signer of the specified document and add trusted capabilities