- operator=
- Assignment operator.
DKPidIP& operator= (const DKPidIP& fromPid);
- getId
- getId has been deprecated and replaced by
getPrimaryId.
virtual DKString getId() const;
- setId
- setId has been deprecated and replaced by
setPrimaryId.
virtual void setId(const char* fromId);
- getPrimaryId
- Gets the datastore-specific primary persistent ID. For ImagePlus
for OS/390, the primary ID is formatted as follows:
For folders:
{DK_IP_PID_FOLD_ID-value}\{DK_IP_PID_FOLD_LASTCHANGE-value}
- DK_IP_PID_FOLD_ID
- value is the FAF folder id consisting of the name assigned to
the folder.
- DK_IP_PID_FOLD_LASTCHANGE
- value is the time stamp when the folder was last
updated.
For documents :
{DK_IP_PID_DOC_ID-value}\{DK_IP_PID_DOC_NAME-value}\
{DK_IP_PID_DOC_FLDID-value}\{DK_IP_PID_DOC_RCVDATE-value}\
{DK_IP_PID_DOC_VERSION-value}\{DK_IP_PID_DOC_COLLECTION-value}\
{DK_IP_PID_DOC_LASTCHANGE-value}
- DK_IP_PID_DOC_ID
- value is the FAF document id consisting of the create site and
time stamp.
- DK_IP_PID_DOC_NAME
- value is the IODM document name used to reference the
document's content.
- DK_IP_PID_DOC_FLDID
- value is the FAF folder id for the folder which contains the
document
- DK_IP_PID_DOC_RCVDATE
- value is the user-specified receive date of the
document.
- DK_IP_PID_DOC_VERSION
- value is the version of the document.
- DK_IP_PID_DOC_COLLECTION
- value is the document's collection name, which consists
of the storage group, management class, and storage class separated by periods
(.).
- DK_IP_PID_DOC_LASTCHANGE
- value is the timestamp when the document was last
updated.
virtual DKString getPrimaryId();
- setPrimaryId
- Sets the datastore specific primary persistent ID. For ImagePlus
for OS/390, the following rules apply:
- The id string count must be set to the appropriate number of strings
before calling this method. See the setIdStringCount
method. (Tip: When specifying the idStringCount for
folder Pids, use DK_ID_PID_COUNT_FOLD, and when specifying the
idStringCount for document Pids, use DK_ID_PID_COUNT_DOC.)
- The strings in the specified primary id must be delimited by a backslash
(\).
The ID string is formatted as follows:
For folders:
{DK_IP_PID_FOLD_ID-value}\{DK_IP_PID_FOLD_LASTCHANGE-value}
- DK_IP_PID_FOLD_ID
- value is the FAF folder id consisting of the name assigned to
the folder.
- DK_IP_PID_FOLD_LASTCHANGE
- value is the timestamp when the folder was last
updated.
For documents:
{DK_IP_PID_DOC_ID-value}\{DK_IP_PID_DOC_NAME-value}\
{DK_IP_PID_DOC_FLDID-value}\{DK_IP_PID_DOC_RCVDATE-value}\
{DK_IP_PID_DOC_VERSION-value}\{DK_IP_PID_DOC_COLLECTION-value}\
{DK_IP_PID_DOC_LASTCHANGE-value}
- DK_IP_PID_DOC_ID
- value is the FAF document id consisting of the create site and
timestamp.
- DK_IP_PID_DOC_NAME
- value is the IODM document name used to reference the
document's content.
- DK_IP_PID_DOC_FLDID
- value is the FAF folder id for the folder which contains the
document
- DK_IP_PID_DOC_RCVDATE
- value is the user-specified receive date of the
document.
- DK_IP_PID_DOC_VERSION
- value is the version of the document.
- DK_IP_PID_DOC_COLLECTION
- value is the document's collection name, which consists
of the storage group, management class, and storage class separated by periods
(.).
- DK_IP_PID_DOC_LASTCHANGE
- value is the timestamp when the document was last
updated.
virtual void setPrimaryId(const char* primaryId);
- clone
- A new DKPid is constructed and returned. The returned
persistent identifier (PID) must be deleted by the caller of this
method.
virtual DKPid* clone();
- pidType
- Gets the persistent identifier (PID) type.
virtual DKString pidType() const;