com.hcl.domino.data

Interface DominoUniversalNoteId

All Superinterfaces:

IAdaptable

public interface DominoUniversalNoteId
extends IAdaptable

The Universal Note ID (UNID) identifies all copies of the same document in different replicas of the same database universally (across all servers).

If one document in one database has the same UNID as another document in a replica database, then the two documents are replicas of each other.

The UNID is used to reference a specific document from another document. Specifically, the $REF field of a response document contains the UNID of it's parent.

Similarly, Doc Links contains the UNID of the linked-to document plus the database ID where the linked-to document can be found. The important characteristic of the UNID is that it continues to reference a specific document even if the document being referenced is updated.

The Domino replicator uses the Universal Note ID to match the documents in one database with their respective copies in replica databases. For example, if database A is a replica copy of database B, database A contains a document with a particular UNID, and database B contains a document with the same UNID, then the replicator concludes that these two documents are replica copies of one another. On the other hand, if database A contains a document with a particular UNID but database B does not, then the replicator will create a copy of that document and add it to database B.

One database must never contain two documents with the same UNID. If the replicator finds two documents with the same UNID in the same database, it generates an error message in the log and does not replicate the document.

The "File" member (getFile()) of the UNID contains a number derived in different ways depending on the release of Domino or Notes.
Pre- 2.1 versions of Notes set the "File" member to the creation date/time of the NSF file in which the document is created. Notes 2.1 sets the "File" member to a user-unique identifier, derived in part from information in the ID of the user creating the document, and in part from the database where the document is created. Notes 3.0 sets the "File" member to a random number generated at the time the document is created.

The "Note" (getNote()) member of the UNID contains the date/time when the very first copy of the document was stored into the first NSF (Note: date/time from $CREATED item, if exists, takes precedence).

Method Summary

Modifier and Type	Method and Description
Optional<DominoDateTime>	getFile() Returns the File part of the universal id
Optional<DominoDateTime>	getNote() Returns the Note part of the universal id
void	setFile(TemporalAccessor td) Changes the File part of the universal id
void	setNote(TemporalAccessor td) Changes the Note part of the universal id
String	toString() Returns the string representation of the universal id (32 character hex string)

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

getAdapter

Method Detail

getFile

Optional<DominoDateTime> getFile()

Returns the File part of the universal id

Returns:

an Optional describing the File part, or an empty one if this has not yet been set

getNote

Optional<DominoDateTime> getNote()

Returns the Note part of the universal id

Returns:

an Optional describing the Note part, or an empty one if this has not yet been set

setNote

void setNote(TemporalAccessor td)

Changes the Note part of the universal id

Parameters:

td - new value for Note

setFile

void setFile(TemporalAccessor td)

Changes the File part of the universal id

Parameters:

td - new value for File

toString

String toString()

Returns the string representation of the universal id (32 character hex string)

Overrides:

toString in class Object

Returns:

UNID string