Index

DKPidICM

Purpose:

This class is used to represent the Persistent Identifier (PID) for data objects that reside in the Content Manager datastore. Each data object represented by a DDO must have a PID for locating its persistent copy in the datastore. Therefore, PIDs are very important elements for supporting persistent operation on data objects such as add, retrieve, update, and delete. DKPidICM class extends DKPid by adding several data members specific to datastore ICM, such as component identifier, component type identifier, and version number.

See Also: DKPid, DKDDOBase, DKDDO, dkDatastore.

Hierarchy:

DKPid

DKPidICM

Since: Version 8

Class summary:

class DKPidICM : public DKPid
 {
   public:
      DKPidICM();
      DKPidICM(DKString aPidString);
      DKPidICM(DKPidICM& aDKPidICM);
      virtual ~DKPidICM();
   
      DKString getPrimaryId();
      void setPrimaryId(DKString primaryId);
      DKString getItemId();
      void setItemId(DKString aItemId);
      DKString getComponentId();
      void setComponentId(DKString aCompId);
      DKString getVersionNumber();
      void setVersionNumber(DKString aVerNum );
      DKBoolean equals(DKAny otherObject);
      DKAny clone();
      DKString pidType();
      DKString getComponentTypeId();
      void setComponentTypeId(const char* aCompId);
 };

Members:

Constructors and Destructor
DKPidICM()

Default constructor. Constructs a Pid.

DKPidICM(DKString aPidString); 

Constructs a Pid using a previously created string form of this Pid. Parameters: aPidString - pid string. This string is usually obtained as a result of the DKPidICM.toPidString() method.

DKPidICM(DKPidICM& pidICM);

Constructs a Pid object for datastore ICM. Parameters: pidICM - the pid for ICM

virtual ~DKPidICM()

Destructor for this object.

Member functions

getPrimaryId()
Gets the datastore specific primary persistent-identifier. For datastoreICM, the primary identifier is the item identifier. Returns: the datastore primary identifier.
DKString getPrimaryId(); 

setPrimaryId()
Sets the datastore specific primary persistent-identifier. Parameters: primaryId - the primary persistent-identifier for this datastore.
void setPrimaryId(DKString primaryId); 

getItemId()
Gets the Item identifier. Returns: the item identifier.
DKString getItemId(); 

setItemId()
Sets the Item identifier. Parameters: aItemId - the item identifier
void setItemId(DKString aItemId);

getComponentId()
Gets the component identifier. Returns: the component identifier.
DKString getComponentId();

setComponentId()
Sets the component identifier. Parameters: aCompId - the component identifier.
void setComponentId(DKString aCompId);

getComponentTypeId()
Gets the component type identifier. Returns: the component type identifier.
DKString getComponentTypeId();

setComponentTypeId()
Sets the component type identifier in this Pid. Parameters: aCompId - the component type identifier.
void setComponentTypeId(const char* aCompId);

getVersionNumber()
Gets the version number. Returns: the version number.
DKString getVersionNumber(); 

setVersionNumber()
Sets the version number. Parameters: aVerNum - a version number.
void setVersionNumber(DKString aVerNum); 

equals()
Compares two Pids for equality. Parameters: aVerNum - a version number. Returns: true if these two to Pids are equals.
DKBoolean equals(DKAny otherObject);

clone()
Clones this PID instance. Returns: the a copy of this Pid.
DKAny clone();

pidType()
Gets the pid type. Returns: the pid type, that is "DKPidICM"
DKString pidType(); 

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