Index

DKPidXDOIP

Purpose:

DKPidXDOIP represents a special persistent identifier (PID) for extended data objects (XDOs) stored in ImagePlus for OS/390.

Class summary:

class DKPidXDOIP : public DKPidXDO
{
  public:
   DKPidXDOIP();
   DKPidXDOIP(const DKPidXDOIP& aDKPidXDO);
 
   virtual ~DKPidXDOIP();
 
   DKPidXDOIP& operator= (DKPidXDOIP& aDKPidXDO);
   virtual DKString getPrimaryId();
   virtual void    setPrimaryId(const char* primaryId);
   unsigned long     getPartId();
   void              setPartId(unsigned long aPartId );
   DKString          getDocId();
   void              setDocId(const char*  aDocId );
   virtual DKBoolean isSet() const;
   virtual DKPid*  clone();
   virtual DKString pidType() const;
};

Members:

Constructors and destructor
Constructs a persistent identifier (PID).
   DKPidXDOIP();
   DKPidXDOIP(const DKPidXDOIP& aDKPidXDO);
 
   virtual ~DKPidXDOIP();
 

Member functions

operator=
Assignment operator.
   DKPidXDOIP& operator= (DKPidXDOIP& aDKPidXDO);
 

getPrimaryId
Gets the datastore-specific primary persistent ID for a content object (BLOB). For ImagePlus for OS/390, the primary ID is formatted as follows:
   {DK_IP_PIDXDO_DOC_NAME-value}\
   {DK_IP_PIDXDO_DOC_COLLECTION-value}\
   {DK_IP_PIDXDO_DOC_CLASS-value}

DK_IP_PIDXDO_DOC_NAME
value is the IODM document name used to reference the document's content.

DK_IP_PIDXDO_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_PIDXDO_DOC_CLASS
value is the object class of the document.

   virtual DKString getPrimaryId();
 

setPrimaryId
Sets the datastore-specific XDO primary persistent ID. For ImagePlus for OS/390, the following rules apply:
  • The id string count must be set to DK_IP_PIDXDO_COUNT_DOC before calling this method.
  • The strings in the specified primary ID must be delimeted by a backslash (\).
  • The ID string should be formatted as follows:

   {DK_IP_PIDXDO_DOC_NAME-value}\
   {DK_IP_PIDXDO_DOC_COLLECTION-value}\
   {DK_IP_PIDXDO_DOC_CLASS-value}

DK_IP_PIDXDO_DOC_NAME
value is the IODM document name used to reference the document's content.

DK_IP_PIDXDO_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_PIDXDO_DOC_CLASS
value is the object class of the document.

   virtual void setPrimaryId(const char* primaryId);
 

getPartId
Gets the part ID.
   unsigned long getPartId();
 

setPartId
Sets the part ID.
   void setPartId(unsigned long aPartId );
 

getDocId
Gets the document ID, which is the FAF document ID. The document ID is required for:
  • Adding document content (an ODM document).
  • Adding annotations to documents (an ODM annotation).
  • Updating annotations.
  • Deleting annotations.

   DKString getDocId();
 

setDocId
Sets the document ID.
   void setDocId(const char*  aDocId );
 

isSet
Indicates whether the persistent identifier (PID) values are set.
   virtual DKBoolean isSet() const;
 

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;
 

(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.