Document (HCL Domino API 1.0.27-SNAPSHOT API)

All Superinterfaces:

IAdaptable, TypedAccess

All Known Subinterfaces:

AutoCloseableDocument
```
public interface Document
extends TypedAccess, IAdaptable
```
Represents a document within an NSF.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Document.ComputeWithFormAction`
`static interface`	`Document.ComputeWithFormCallback` Callback to get notified about errors during `computeWithForm(boolean, ComputeWithFormCallback)`
`static class`	`Document.ComputeWithFormPhase` Possible validation phases for `computeWithForm(boolean, ComputeWithFormCallback)`
`static class`	`Document.EncryptionMode`
`static interface`	`Document.IAttachmentProducer` Interface to create document attachments in-memory without the need to write files to disk.
`static class`	`Document.LockMode` Document locking mode
`static interface`	`Document.SignatureData` Container for note signature data

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Stream<Item>`	`allItems()` Returns a stream of all document items
`Document`	`appendItemValue(String itemName, Object value)` Appends an item value to the document, leaving any other items of the same name in place.
`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`	`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.
`void`	`appendToTextList(String itemName, String value, boolean allowDuplicates)` This function appends an entry to a text list item. If the text list item does not already exist, one will be created using the name provided and the text provided as the FIRST entry.
`Attachment`	`attachFile(String filePathOnDisk, String uniqueFileNameInDoc, Attachment.Compression compression)` Attaches a file to the document, not associated with a rich-text item.
`Attachment`	`attachFile(String uniqueFileNameInDoc, TemporalAccessor fileCreated, TemporalAccessor fileModified, Document.IAttachmentProducer producer)` Attaches a file to the document, not associated with a rich-text item.
`AutoCloseableDocument`	`autoClosable()` Returns an instance of this document that implements the `AutoCloseableDocument` interface and can be used within a try-with-resources block for immediate handle disposal.
`void`	`compileLotusScript()` Compiles all LotusScript attached to this note
`void`	`computeWithForm(boolean continueOnError, Document.ComputeWithFormCallback callback)` For each form field associated with this document, this function will: Validate fields with Default Value formulas, Validate fields with Translation formulas, Validate fields with Validation formulas, Calculate values for Computed fields. If no error callback routine is supplied and the flag `continueOnError` is not set, if one of the validation formulas fails, an error is returned. If the `continueOnError` flag is set, the error is not returned. If a callback routine is supplied and one of the validation formulas fails, the error callback routine is called. If the `continueOnError` flag is set, error processing for the field is skipped; if a callback function is supplied, the callback function will be ignored.
`boolean`	`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.
`boolean`	`convertRichTextItem(String itemName, IRichTextConversion... conversions)` Applies one or multiple conversions to a rich text item, updating the original item in-place.
`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`	`copyToDatabase(Database otherDb)` Copies the document to another database.
`RichTextWriter`	`createRichTextItem(String itemName)` Creates a writer for a new rich-text item on the document.
`void`	`decrypt(UserId id)` Decrypts the contents of the document.
`void`	`delete()` Deletes the document from the database.
`void`	`delete(boolean noStub)` Deletes the document from the database.
`void`	`forEachAttachment(BiConsumer<Attachment,Loop> consumer)` Iterates over each attachment in the document, until all attachments have been processed or the consumer calls `Loop.stop()`.
`void`	`forEachItem(BiConsumer<Item,Loop> consumer)` Iterates over all document items
`void`	`forEachItem(String itemName, BiConsumer<Item,Loop> consumer)` Iterates over all document items with the specified name
`DominoDateTime`	`getAddedToFile()` Retrives the time when the document was added to this NSF, regardless of when it was originally created.
`String`	`getAsText(String itemName, char separator)` Retrieves the item value as text.
`Optional<Attachment>`	`getAttachment(String fileName)` Retrieves a document attachment by name.
`DominoDateTime`	`getCreated()` Retrieves the creation date of this document.
`Set<DocumentClass>`	`getDocumentClass()` Returns the document classes that apply to this document
`Optional<Item>`	`getFirstItem(String itemName)` Retrieves the first item of the given name on the document.
`List<?>`	`getItemValue(String itemName)` Retrieves the value of the first item of the given name on the document as its closest Java-type match.
`DominoDateTime`	`getLastAccessed()` Retrieves the last-accessed time of the document, if that information is being tracked in the database.
`DominoDateTime`	`getLastModified()` Retrieves the time when the document was last modified.
`List<String>`	`getLockHolders()`
`DominoDateTime`	`getModifiedInThisFile()` Retrieves the time when the document was last modified in this NSF, which may be later than the last time it was modified on any replica.
`int`	`getNoteID()` Retrieves the note ID of this document.
`DominoOriginatorId`	`getOID()` Retrieves the originator ID of the document, which contains the UNID and additional modification information.
`Database`	`getParentDatabase()` Retrieves the parent database of this document.
`default String`	`getParentDocumentUNID()` Retrieves the UNID of the parent document of this document, if present.
`String`	`getPrimaryKeyCategory()` Returns the category part of the note primary key
`String`	`getPrimaryKeyObjectId()` Returns the object id part of the note primary key
`String`	`getProfileName()` For profile documents, this method returns the name of the profile
`String`	`getProfileUserName()` For profile documents, this method returns the username of the profile owner
`List<Item>`	`getReadersFields()` The function returns all the readers items of the document
`int`	`getResponseCount()` Retrieves the count of response documents to this document.
`IDTable`	`getResponses()` Retrieves the response documents to this document.
`default RichTextRecordList`	`getRichTextItem(String itemName)` Retrieves the named rich-text item as an unmodifiable `List` of composite data records.
`RichTextRecordList`	`getRichTextItem(String itemName, RecordType.Area variant)` Retrieves the named rich text item as an unmodifiable `List` of composite data records, to be treated as a specific variant of rich text.
`int`	`getSequenceNumber()` Retrieves the modification sequence number of the document.
`String`	`getSigner()` Returns the signer of a note
`String`	`getUNID()` Retrieves the universal ID of the document, which is unique across replicas.
`boolean`	`hasComposite()` Returns TRUE if the given note contains any `ItemDataType.TYPE_COMPOSITE` items.
`boolean`	`hasItem(String itemName)` The method checks whether an item exists
`boolean`	`hasMIME()` Returns TRUE if the given note contains either `ItemDataType.TYPE_RFC822_TEXT` items or `ItemDataType.TYPE_MIME_PART` items.
`boolean`	`hasMIMEPart()` The function returns TRUE if the given note contains any `ItemDataType.TYPE_MIME_PART` items.
`boolean`	`hasReadersField()` The function returns TRUE if the given document contains any items with reader access flag
`boolean`	`isEditable()` Returns true if the current user has sufficient access rights to modify the document.
`boolean`	`isEncrypted()` Checks whether this note is sealed
`boolean`	`isHiddenFromViews()` Returns true if this is a ghost document.
`boolean`	`isNew()` Returns true if the document has not been saved yet
`default boolean`	`isResponse()` Checks if this document is a response
`boolean`	`isSaveMessageOnSend()` Indicates whether a document is saved to a database when mailed.
`boolean`	`isSigned()` Checks whether this note is signed
`boolean`	`isSoftDeleted()` Returns true if the document has been deleted in a database that has soft deletions enabled.
`boolean`	`isTruncated()` Indicates that the note has been abstracted (truncated). This is the case if the database containing the note has replication settings set to "Truncate large documents and remove attachments".
`boolean`	`isUnread()` Checks if the document is unread for the user returned by `DominoClient.getEffectiveUserName()`. Uses `Database.isDocumentUnread(String, int)` internally.
`boolean`	`isUnread(String userName)` Checks if the document is unread for the specified user. Uses `Database.isDocumentUnread(String, int)` internally.
`boolean`	`lock(List<String> lockHolders, Document.LockMode mode)` This function adds an "$Writers" field to a note which contains a list of "writers" who will be able to update the note. Any user will be able to open the note, but only the members contained in the "$Writers" field are allowed to update the note. This function will only succeed if the database option "Allow document locking" is set. Please refer to the Domino documentation for a full description of document locking.
`boolean`	`lock(String lockHolder, Document.LockMode mode)` This function adds an "$Writers" field to a note which contains a list of "writers" who will be able to update the note. Any user will be able to open the note, but only the members contained in the "$Writers" field are allowed to update the note. This function will only succeed if the database option "Allow document locking" is set. Please refer to the Domino documentation for a full description of document locking.
`void`	`makeResponse(Document doc)` Makes the document a response to another document.
`void`	`makeResponse(String unid)` Makes the document a response to another document identified by UNID.
`void`	`removeAttachment(String uniqueFileNameInDoc)` Removes an attachment by the unique internal file name.
`void`	`removeItem(String itemName)` Removes the first item of the provided name from the 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`	`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`	`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`	`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.
`void`	`save()` Writes in-memory changes to a document to the database.
`void`	`save(boolean force)` Writes in-memory changes to a document to the database.
`void`	`send()` Mails the note Convenience function that calls `send(boolean, Collection)`.
`void`	`send(boolean attachform)` Mails the document Convenience function that calls `send(boolean, Collection)`.
`void`	`send(boolean attachform, Collection<String> recipients)` Mails the document Two kinds of items can affect the mailing of the document when you use send: If the document contains additional recipient items, such as CopyTo or BlindCopyTo, the documents mailed to those recipients. If the document contains items to control the routing of mail, such as DeliveryPriority, DeliveryReport, or ReturnReceipt, they are used when sending the document. The `isSaveMessageOnSend()` property controls whether the sent document is saved in the database.
`void`	`send(boolean attachform, String recipient)` Mails the document Convenience function that calls `send(boolean, Collection)`.
`void`	`send(Collection<String> recipients)` Mails the document Convenience function that calls `send(boolean, Collection)`.
`void`	`send(String recipient)` Mails the document Convenience function that calls `send(boolean, Collection)`.
`Document`	`setDocumentClass(DocumentClass docClass)` Sets the class of this document.
`void`	`setPrimaryKey(String category, String objectId)` Writes a primary key information to the note.
`void`	`setSaveMessageOnSend(boolean b)` Indicates whether a document is saved to a database when mailed.
`void`	`setUNID(String newUNID)` Sets the universal ID for the document.
`void`	`setUnread(String userName, boolean unread)` Method to change the unread state of the document
`void`	`sign()` Signs the document using the active Notes ID.
`void`	`sign(UserId id, boolean signNotesIfMimePresent)` Function to sign all items in the document. It allows you to pass a flag to determine how MIME parts will be signed. If the note has MIME parts then it will be SMIME signed.
`int`	`size()` Returns the total size of the document
`void`	`undelete()` Undeletes a soft deleted document
`void`	`unlock(Document.LockMode mode)` This function removes the lock on a note. Only the members contained in the "writers" list are allowed to remove a lock, with the exception of person(s) designated as capable of removing locks. Please refer to the Domino documentation for a full description of document locking.#
`void`	`unsign()` Unsigns the note.
`Document.SignatureData`	`verifySignature()` This function verifies a signature on a note or section(s) within a note. It returns an error if a signature did not verify.

Methods inherited from interface com.hcl.domino.data.TypedAccess
get, getAsList, getItemNames

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

- Method Detail
  - autoClosable
```
AutoCloseableDocument autoClosable()
```
    Returns an instance of this document that implements the AutoCloseableDocument interface and can be used within a try-with-resources block for immediate handle disposal. The purpose of this method is to get more control about the platform memory usage instead of leaving this work up to the JNX garbage collector.
    
    Returns:
    
    auto-closeable document
  - getParentDatabase
```
Database getParentDatabase()
```
    Retrieves the parent database of this document.
    
    Returns:
    
    the parent Database
  - getNoteID
```
int getNoteID()
```
    Retrieves the note ID of this document. This value is specific to the NSF and is not unique across replicas.
    
    Returns:
    
    the integer note ID
  - getUNID
```
String getUNID()
```
    Retrieves the universal ID of the document, which is unique across replicas.
    
    Returns:
    
    the document's UNID as a 32-character hexadecimal string
  - getOID
```
DominoOriginatorId getOID()
```
    Retrieves the originator ID of the document, which contains the UNID and additional modification information.
    
    Returns:
    
    a DominoOriginatorId object, never null
  - getSequenceNumber
```
int getSequenceNumber()
```
    Retrieves the modification sequence number of the document.
    
    Returns:
    
    an integer sequence number
  - getCreated
```
DominoDateTime getCreated()
```
    Retrieves the creation date of this document.
    Note: by default, this value is derived from the document's UNID, but can be overridden by the presence of a $Created date/time item.
    
    Returns:
    
    the timestamp of the document's creation
  - getLastModified
```
DominoDateTime getLastModified()
```
    Retrieves the time when the document was last modified.
    
    Returns:
    
    the timestamp of the document's last modification
  - getModifiedInThisFile
```
DominoDateTime getModifiedInThisFile()
```
    Retrieves the time when the document was last modified in this NSF, which may be later than the last time it was modified on any replica.
    
    Returns:
    
    the timestamp of the document's last modification in this NSF
  - getLastAccessed
```
DominoDateTime getLastAccessed()
```
    Retrieves the last-accessed time of the document, if that information is being tracked in the database.
    
    Returns:
    
    the timestamp of the document last access; may be the minimum time value if access are not being tracked
  - getAddedToFile
```
DominoDateTime getAddedToFile()
```
    Retrives the time when the document was added to this NSF, regardless of when it was originally created.
    
    Returns:
    
    the timestamp of when the document was added to the file
  - getFirstItem
```
Optional<Item> getFirstItem(String itemName)
```
    Retrieves the first item of the given name on the document.
    
    Parameters:
    
    itemName - the name of the item to retrieve
    
    Returns:
    
    an Optional describing the Item, or an empty one if no such item exists
  - getItemValue
```
List<?> getItemValue(String itemName)
```
    Retrieves the value of the first item of the given name on the document as its closest Java-type match.
    
    Parameters:
    
    itemName - the name of the item to retrieve
    
    Returns:
    
    a List of item values, never null
  - getAttachment
```
Optional<Attachment> getAttachment(String fileName)
```
    Retrieves a document attachment by name.
    
    Parameters:
    
    fileName - the name of the attachment stored in the document
    
    Returns:
    
    an Optional describing the attachment, or an empty one if no such attachment exists
  - forEachAttachment
```
void forEachAttachment(BiConsumer<Attachment,Loop> consumer)
```
    Iterates over each attachment in the document, until all attachments have been processed or the consumer calls Loop.stop().
    
    Parameters:
    
    consumer - a BiConsumer to process the attachments
  - forEachItem
```
void forEachItem(BiConsumer<Item,Loop> consumer)
```
    Iterates over all document items
    
    Parameters:
    
    consumer - consumer to receive the Item
  - forEachItem
```
void forEachItem(String itemName,
                 BiConsumer<Item,Loop> consumer)
```
    Iterates over all document items with the specified name
    
    Parameters:
    
    itemName - item name
    
    consumer - consumer to receive the Item
  - appendItemValue
```
Document appendItemValue(String itemName,
                         Object value)
```
    Appends an item value to the document, leaving any other items of the same name in place.
    
    Parameters:
    
    itemName - the name of the item to append
    
    value - the value of the item to store
    
    Returns:
    
    this document
  - appendItemValue
```
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.
    
    Parameters:
    
    itemName - the name of the item to append
    
    flags - a collection of Item.ItemFlag to apply to the item
    
    value - the value of the item to store
    
    Returns:
    
    this document
  - appendItemValue
```
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.
    
    Parameters:
    
    itemName - the name of the item to append
    
    flags - a collection of Item.ItemFlag to apply to the item
    
    value - the value of the item to store
    
    allowDataTypeChanges - to append the item even if its type doesn't match the existing values
    
    Returns:
    
    this document
  - replaceItemValue
```
Document replaceItemValue(String itemName,
                          Object value)
```
    Sets the value of an item value to the document, replacing any other items of the same name.
    
    Parameters:
    
    itemName - the name of the item to store
    
    value - the value of the item to store
    
    Returns:
    
    this document
  - replaceItemValue
```
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.
    
    Parameters:
    
    itemName - the name of the item to store
    
    value - the value of the item to store
    
    allowDataTypeChanges - to append the item even if its type doesn't match the existing values
    
    Returns:
    
    this document
  - replaceItemValue
```
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.
    
    Parameters:
    
    itemName - the name of the item to store
    
    value - the value of the item to store
    
    flags - a collection of Item.ItemFlag to apply to the item
    
    Returns:
    
    this document
  - replaceItemValue
```
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.
    
    Parameters:
    
    itemName - the name of the item to store
    
    value - the value of the item to store
    
    flags - a collection of Item.ItemFlag to apply to the item
    
    allowDataTypeChanges - to append the item even if its type doesn't match the existing values
    
    Returns:
    
    this document
  - createRichTextItem
```
RichTextWriter createRichTextItem(String itemName)
```
    Creates a writer for a new rich-text item on the document.
    
    Parameters:
    
    itemName - the name of the rich-text item to create
    
    Returns:
    
    a RichTextWriter to provide the item contents
  - getRichTextItem
```
default RichTextRecordList getRichTextItem(String itemName)
```
    Retrieves the named rich-text item as an unmodifiable List of composite data records.
    This data may span multiple items of the same name, and all are included in the returned list.
    
    Note: though presented as a List, some operations (in particular size()) are particularly expensive. The most efficient way to traverse the result is via Collection.stream() or List.listIterator().
    
    Parameters:
    
    itemName - the name of the rich text item to retrieve
    
    Returns:
    
    a List of RichTextRecord objects
  - getRichTextItem
```
RichTextRecordList getRichTextItem(String itemName,
                                   RecordType.Area variant)
```
    Retrieves the named rich text item as an unmodifiable List of composite data records, to be treated as a specific variant of rich text.
    This data may span multiple items of the same name, and all are included in the returned list.
    
    Note: though presented as a List, some operations (in particular size()) are particularly expensive. The most efficient way to traverse the result is via Collection.stream() or List.listIterator().
    
    Parameters:
    
    itemName - the name of the rich text item to retrieve
    
    variant - the data area variant represented by the item
    
    Returns:
    
    a List of RichTextRecord objects
  - attachFile
```
Attachment attachFile(String filePathOnDisk,
                      String uniqueFileNameInDoc,
                      Attachment.Compression compression)
```
    Attaches a file to the document, not associated with a rich-text item.
    Unlike attachFile(String, TemporalAccessor, TemporalAccessor, IAttachmentProducer), this method reads data from the named file on disk directly.
    
    Parameters:
    
    filePathOnDisk - a path to the file on disk
    
    uniqueFileNameInDoc - a name for the attachment in the document
    
    compression - the compression scheme to use when storing the attachment
    
    Returns:
    
    the newly-created document attachment
  - attachFile
```
Attachment attachFile(String uniqueFileNameInDoc,
                      TemporalAccessor fileCreated,
                      TemporalAccessor fileModified,
                      Document.IAttachmentProducer producer)
```
    Attaches a file to the document, not associated with a rich-text item.
    Unlike #attachFile(String, String, Compression), this method allows for specifying file metadata and source binary data arbitrarily. It does not use compression. No temp file is created on disk.
    
    Parameters:
    
    uniqueFileNameInDoc - a name for the attachment in the document
    
    fileCreated - the creation date for the stored file
    
    fileModified - the modification date for the stored file
    
    producer - a Document.IAttachmentProducer implementation that provides the attachment data
    
    Returns:
    
    the newly-created document attachment
  - removeItem
```
void removeItem(String itemName)
```
    Removes the first item of the provided name from the document.
    
    Parameters:
    
    itemName - the case-insensitive name of the item to remove
  - removeAttachment
```
void removeAttachment(String uniqueFileNameInDoc)
```
    Removes an attachment by the unique internal file name.
    Note: this does not remove references to the document from rich-text items.
    
    Parameters:
    
    uniqueFileNameInDoc - the unique internal name of the attachment in the document
    
    See Also:
    
    RemoveAttachmentIconConversion
  - makeResponse
```
void makeResponse(Document doc)
```
    Makes the document a response to another document.
    
    Parameters:
    
    doc - the parent document
  - makeResponse
```
void makeResponse(String unid)
```
    Makes the document a response to another document identified by UNID.
    
    Parameters:
    
    unid - the UNID of the parent document
  - isResponse
```
default boolean isResponse()
```
    Checks if this document is a response
    
    Returns:
    
    true if response
  - sign
```
void sign()
```
    Signs the document using the active Notes ID.
  - sign
```
void sign(UserId id,
          boolean signNotesIfMimePresent)
```
    Function to sign all items in the document.
    It allows you to pass a flag to determine how MIME parts will be signed.
    If the note has MIME parts then it will be SMIME signed. If not, or the signNotesIfMimePresent parameter is set to allow Notes signature on MIME parts, then it will be Notes signed. If the document to be signed is encrypted, this function will attempt to decrypt the document in order to generate a valid signature.
    
    If you want the document to be signed and encrypted, you must sign the document before using copyAndEncrypt(UserId, Collection).
    
    Parameters:
    
    id - id to sign, null for active ID
    
    signNotesIfMimePresent - If the note has MIME parts and this flag is true it will be SMIME signed, if not set it will be Notes signed.
  - unsign
```
void unsign()
```
    Unsigns the note. This function removes the $Signature item from the note.
  - verifySignature
```
Document.SignatureData verifySignature()
```
    This function verifies a signature on a note or section(s) within a note.
    It returns an error if a signature did not verify.
    
    Returns:
    
    signer data
  - copyAndEncrypt
```
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.
    
    Parameters:
    
    id - user id to be used for encryption, use null for current id
    
    encryptionMode - encryption mode
    
    Returns:
    
    encrypted document copy
  - setUNID
```
void setUNID(String newUNID)
```
    Sets the universal ID for the document.
    
    Parameters:
    
    newUNID - a 32-character hexadecimal string
  - copyToDatabase
```
Document copyToDatabase(Database otherDb)
```
    Copies the document to another database.
    
    Parameters:
    
    otherDb - the target database to store the copied document
    
    Returns:
    
    the copied document in the target database
  - decrypt
```
void decrypt(UserId id)
```
    Decrypts the contents of the document.
    
    Parameters:
    
    id - the UserId to use for decryption, or null to use the active runtime Notes ID
  - delete
```
void delete()
```
    Deletes the document from the database.
    This is equivalent to calling delete(false).
  - delete
```
void delete(boolean noStub)
```
    Deletes the document from the database.
    
    Parameters:
    
    noStub - whether to purge the document without leaving a deletion stub
  - save
```
void save()
```
    Writes in-memory changes to a document to the database.
    This is equivalent to calling save(false).
  - save
```
void save(boolean force)
```
    Writes in-memory changes to a document to the database.
    
    Parameters:
    
    force - whether to save the document even if another user has modified or deleted it
  - getLockHolders
```
List<String> getLockHolders()
```
    Returns:
    
    a List of user names that currently have a lock on the document
  - getDocumentClass
```
Set<DocumentClass> getDocumentClass()
```
    Returns the document classes that apply to this document
    
    Returns:
    
    a Set of DocumentClass values
  - setDocumentClass
```
Document setDocumentClass(DocumentClass docClass)
```
    Sets the class of this document.
    
    Parameters:
    
    docClass - the DocumentClass value to set
    
    Returns:
    
    this document
    
    Since:
    
    1.0.15
  - lock
```
boolean lock(String lockHolder,
             Document.LockMode mode)
```
    This function adds an "$Writers" field to a note which contains a list of "writers" who will be able to update the note.
    
    Any user will be able to open the note, but only the members contained in the "$Writers" field are allowed to update the note.
    
    This function will only succeed if the database option "Allow document locking" is set.
    
    Please refer to the Domino documentation for a full description of document locking.
    
    Parameters:
    
    lockHolder - new lock holder
    
    mode - lock mode
    
    Returns:
    
    true if successful, false if already locked
  - lock
```
boolean lock(List<String> lockHolders,
             Document.LockMode mode)
```
    This function adds an "$Writers" field to a note which contains a list of "writers" who will be able to update the note.
    
    Any user will be able to open the note, but only the members contained in the "$Writers" field are allowed to update the note.
    
    This function will only succeed if the database option "Allow document locking" is set.
    
    Please refer to the Domino documentation for a full description of document locking.
    
    Parameters:
    
    lockHolders - new lock holders
    
    mode - lock mode
    
    Returns:
    
    true if successful, false if already locked
  - unlock
```
void unlock(Document.LockMode mode)
```
    This function removes the lock on a note.
    
    Only the members contained in the "writers" list are allowed to remove a lock, with the exception of person(s) designated as capable of removing locks.
    
    Please refer to the Domino documentation for a full description of document locking.#
    
    Parameters:
    
    mode - lock mode
  - isEditable
```
boolean isEditable()
```
    Returns true if the current user has sufficient access rights to modify the document.
    
    Returns:
    
    true if editable
  - hasReadersField
```
boolean hasReadersField()
```
    The function returns TRUE if the given document contains any items with reader access flag
    
    Returns:
    
    true if readers field
  - getReadersFields
```
List<Item> getReadersFields()
```
    The function returns all the readers items of the document
    
    Returns:
    
    array with readers fields
  - getResponseCount
```
int getResponseCount()
```
    Retrieves the count of response documents to this document.
    Note: due to the lower-level API, this is likely to be more efficient than retrieving the response document collection and checking its count.
    
    Returns:
    
    the count of the document's responses
    
    Since:
    
    1.0.9
  - getResponses
```
IDTable getResponses()
```
    Retrieves the response documents to this document.
    In order for this method to return the response table, this document must have been opened with the Database.OpenDocumentMode.LOAD_RESPONSES flag.
    
    Returns:
    
    an IDTable of responses
    
    Since:
    
    1.0.9
  - hasMIME
```
boolean hasMIME()
```
    Returns TRUE if the given note contains either ItemDataType.TYPE_RFC822_TEXT items or ItemDataType.TYPE_MIME_PART items.
    
    Returns:
    
    true if mime
  - hasMIMEPart
```
boolean hasMIMEPart()
```
    The function returns TRUE if the given note contains any ItemDataType.TYPE_MIME_PART items.
    
    Returns:
    
    true if mime part
  - hasComposite
```
boolean hasComposite()
```
    Returns TRUE if the given note contains any ItemDataType.TYPE_COMPOSITE items.
    
    Returns:
    
    true if composite
  - hasItem
```
boolean hasItem(String itemName)
```
    The method checks whether an item exists
    
    Specified by:
    
    hasItem in interface TypedAccess
    
    Parameters:
    
    itemName - item name
    
    Returns:
    
    true if the item exists
  - getSigner
```
String getSigner()
```
    Returns the signer of a note
    
    Returns:
    
    signer or empty string if not signed
  - isSigned
```
boolean isSigned()
```
    Checks whether this note is signed
    
    Returns:
    
    true if signed
  - isSoftDeleted
```
boolean isSoftDeleted()
```
    Returns true if the document has been deleted in a database that has soft deletions enabled. Use undelete() to undelete the document.
    
    Returns:
    
    true if soft deleted
  - isNew
```
boolean isNew()
```
    Returns true if the document has not been saved yet
    
    Returns:
    
    true if new
  - isEncrypted
```
boolean isEncrypted()
```
    Checks whether this note is sealed
    
    Returns:
    
    true if sealed
  - getProfileName
```
String getProfileName()
```
    For profile documents, this method returns the name of the profile
    
    Returns:
    
    profile name or empty string
  - getProfileUserName
```
String getProfileUserName()
```
    For profile documents, this method returns the username of the profile owner
    
    Returns:
    
    username or empty string
  - getPrimaryKeyCategory
```
String getPrimaryKeyCategory()
```
    Returns the category part of the note primary key
    
    Returns:
    
    category or empty string if no primary key has been assigned
  - getPrimaryKeyObjectId
```
String getPrimaryKeyObjectId()
```
    Returns the object id part of the note primary key
    
    Returns:
    
    object id or empty string if no primary key has been assigned
  - setPrimaryKey
```
void setPrimaryKey(String category,
                   String objectId)
```
    Writes a primary key information to the note. This primary key can be used for efficient note retrieval without any lookup views.
    
    Both category and objectKey are combined to a string that is expected to be unique within the database.
    
    Parameters:
    
    category - category part of primary key
    
    objectId - object id part of primary key
  - isTruncated
```
boolean isTruncated()
```
    Indicates that the note has been abstracted (truncated).
    This is the case if the database containing the note has replication settings set to "Truncate large documents and remove attachments".
    
    Returns:
    
    true if truncated
  - isHiddenFromViews
```
boolean isHiddenFromViews()
```
    Returns true if this is a ghost document. Ghost documents do not show up in views. These kind of documents can be created via Database.createDocument(Set) with Database.CreateFlags.HIDE_FROM_VIEWS
    
    Returns:
    
    true if hidden
  - send
```
void send()
```
    Mails the note
    Convenience function that calls send(boolean, Collection).
  - send
```
void send(String recipient)
```
    Mails the document
    Convenience function that calls send(boolean, Collection).
    
    Parameters:
    
    recipient - The recipient of the document, may include people, groups, or mail-in databases.
  - send
```
void send(Collection<String> recipients)
```
    Mails the document
    Convenience function that calls send(boolean, Collection).
    
    Parameters:
    
    recipients - The recipients of the document, may include people, groups, or mail-in databases.
  - send
```
void send(boolean attachform)
```
    Mails the document
    Convenience function that calls send(boolean, Collection).
    
    Parameters:
    
    attachform - If true, the form is stored and sent along with the document. If false, it isn't. Do not attach a form that uses computed subforms.
  - send
```
void send(boolean attachform,
          String recipient)
```
    Mails the document
    Convenience function that calls send(boolean, Collection).
    
    Parameters:
    
    attachform - If true, the form is stored and sent along with the document. If false, it isn't. Do not attach a form that uses computed subforms.
    
    recipient - The recipient of the document, may include people, groups, or mail-in databases.
  - isSaveMessageOnSend
```
boolean isSaveMessageOnSend()
```
    Indicates whether a document is saved to a database when mailed.
    
    Returns:
    
    true to save on send
  - setSaveMessageOnSend
```
void setSaveMessageOnSend(boolean b)
```
    Indicates whether a document is saved to a database when mailed.
    
    Parameters:
    
    b - true to save on send
  - send
```
void send(boolean attachform,
          Collection<String> recipients)
```
    Mails the document
    
    Two kinds of items can affect the mailing of the document when you use send:
    - If the document contains additional recipient items, such as CopyTo or BlindCopyTo, the documents mailed to those recipients.
    - If the document contains items to control the routing of mail, such as DeliveryPriority, DeliveryReport, or ReturnReceipt, they are used when sending the document.
    The isSaveMessageOnSend() property controls whether the sent document is saved in the database. If isSaveMessageOnSend() is true and you attach the form to the document, the form is saved with the document.
    Sending the form increases the size of the document, but ensures that the recipient can see all of the items on the document.
    Parameters:
    
    attachform - If true, the form is stored and sent along with the document. If false, it isn't. Do not attach a form that uses computed subforms.
    
    recipients - The recipients of the document, may include people, groups, or mail-in databases.
  - computeWithForm
```
void computeWithForm(boolean continueOnError,
                     Document.ComputeWithFormCallback callback)
```
    For each form field associated with this document, this function will:
    1. Validate fields with Default Value formulas,
    2. Validate fields with Translation formulas,
    3. Validate fields with Validation formulas,
    4. Calculate values for Computed fields.
    If no error callback routine is supplied and the flag continueOnError is not set, if one of the validation formulas fails, an error is returned.
    If the continueOnError flag is set, the error is not returned.
    
    If a callback routine is supplied and one of the validation formulas fails, the error callback routine is called.
    If the continueOnError flag is set, error processing for the field is skipped;
    if a callback function is supplied, the callback function will be ignored.
    Parameters:
    
    continueOnError - Ignore error processing for fields
    
    callback - error callback routine
  - isUnread
```
boolean isUnread(String userName)
```
    Checks if the document is unread for the specified user.
    Uses Database.isDocumentUnread(String, int) internally.
    
    Parameters:
    
    userName - username in abbreviated or canonical format, if null, we use DominoClient.getEffectiveUserName()
    
    Returns:
    
    true if unread
  - isUnread
```
boolean isUnread()
```
    Checks if the document is unread for the user returned by DominoClient.getEffectiveUserName().
    Uses Database.isDocumentUnread(String, int) internally.
    
    Returns:
    
    true if unread
  - setUnread
```
void setUnread(String userName,
               boolean unread)
```
    Method to change the unread state of the document
    
    Parameters:
    
    userName - username in abbreviated or canonical format, if null, we use DominoClient.getEffectiveUserName()
    
    unread - true to mark unread, false to mark read
  - allItems
```
Stream<Item> allItems()
```
    Returns a stream of all document items
    
    Returns:
    
    items
  - convertRichTextItem
```
boolean convertRichTextItem(String itemName,
                            IRichTextConversion... conversions)
```
    Applies one or multiple conversions to a rich text item, updating the original item in-place.
    
    Parameters:
    
    itemName - rich text item name
    
    conversions - conversions, processed from left to right
    
    Returns:
    
    true if rich text has been updated, false if all conversion classes returned IRichTextConversion.isMatch(List) as false
  - convertRichTextItem
```
boolean 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.
    
    Parameters:
    
    itemName - rich text item name
    
    targetNote - note to copy to conversion result to
    
    targetItemName - item name in target note where we should save the conversion result
    
    conversions - conversions, processed from left to right
    
    Returns:
    
    true if rich text has been updated, false if all conversion classes returned IRichTextConversion.isMatch(List) as false
  - undelete
```
void undelete()
```
    Undeletes a soft deleted document
  - compileLotusScript
```
void compileLotusScript()
```
    Compiles all LotusScript attached to this note
    
    Throws:
    
    LotusScriptCompilationException - if there is a compilation problem
    
    Since:
    
    1.0.5
  - getAsText
```
String getAsText(String itemName,
                 char separator)
```
    Retrieves the item value as text.
    This differs from calling TypedAccess.get(java.lang.String, java.lang.Class<T>, T) with `String.class` as the type in that it uses an internal Domino routine to convert values to text.
    
    Parameters:
    
    itemName - the name of the item to retrieve
    
    separator - a separator character to use when the item is multi-value
    
    Returns:
    
    the item value as a string
    
    Since:
    
    1.0.5
  - getParentDocumentUNID
```
default String getParentDocumentUNID()
```
    Retrieves the UNID of the parent document of this document, if present.
    This is equivalent to calling get("$REF", String.class, "").
    
    Returns:
    
    the UNID of the document's parent, or an empty string if the document has no parent
    
    Since:
    
    1.0.7
  - size
```
int size()
```
    Returns the total size of the document
    
    Returns:
    
    size
  - appendToTextList
```
void appendToTextList(String itemName,
                      String value,
                      boolean allowDuplicates)
```
    This function appends an entry to a text list item.
    
    If the text list item does not already exist, one will be created using the name provided and the text provided as the FIRST entry. The item flags are set to Item.ItemFlag.SUMMARY.
    
    Parameters:
    
    itemName - item name
    
    value - string containing the text you wish to add as the NEXT entry in the existing text list in the document
    
    allowDuplicates - A boolean containing a flag indicating whether or not to allow duplicate entries in the text list. true - If you wish to allow them and false - If you do not.

Interface Document

Nested Class Summary

Method Summary

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

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

Method Detail

autoClosable

getParentDatabase

getNoteID

getUNID

getOID

getSequenceNumber

getCreated

getLastModified

getModifiedInThisFile

getLastAccessed

getAddedToFile

getFirstItem

getItemValue

getAttachment

forEachAttachment

forEachItem

forEachItem

appendItemValue

appendItemValue

appendItemValue

replaceItemValue

replaceItemValue

replaceItemValue

replaceItemValue

createRichTextItem

getRichTextItem

getRichTextItem

attachFile

attachFile

removeItem

removeAttachment

makeResponse

makeResponse

isResponse

sign

sign

unsign

verifySignature

copyAndEncrypt

setUNID

copyToDatabase

decrypt

delete

delete

save

save

getLockHolders

getDocumentClass

setDocumentClass

lock

lock

unlock

isEditable

hasReadersField

getReadersFields

getResponseCount

getResponses

hasMIME

hasMIMEPart

hasComposite

hasItem

getSigner

isSigned

isSoftDeleted

isNew

isEncrypted

getProfileName

getProfileUserName

getPrimaryKeyCategory

getPrimaryKeyObjectId

setPrimaryKey

isTruncated

isHiddenFromViews

send