Index

DKPidXDODL

Purpose:

DKPidXDODL is a specific PidXDO for XDOs stored in Content Manager datastore. This class has information on part IDs, where the data comes from.

Heirarchy:

dkPid
  dkPidXDO
    dkPidXDODL

Class summary:

class DKPidXDODL : public DKPidXDO
{
  public:
   DKPidXDODL();
   DKPidXDODL(const char * aPidString);
   DKPidXDODL(const DKPidXDODL& aDKPidXDODL);
   virtual ~DKPidXDODL();
 
   DKPidXDODL& operator= (DKPidXDODL& aDKPidXDODL);
   virtual DKString getId() const;
   virtual void    setId(const char* fromId);
   virtual DKString getPrimaryId();
   virtual void    setPrimaryId(const char* primaryId);
   unsigned long     getPartId();
   void              setPartId(unsigned long aPartId );
   virtual DKBoolean isSet() const;
   DKString          getRepType();
   void              setRepType(const char*  aRType );
   DKString          getItemId();
   void              setItemId(const char*  aItemId );
   virtual DKPid*  clone();
   virtual DKString pidType() const;
};

Members:

Constructors and destructor
aPidString is an DKString obtained as a return value from calling the pidString() function.

Exceptions

DKUsageError
Error messages:
  • PID string invalid
   DKPidXDODL();
   DKPidXDODL(const char * aPidString);
   DKPidXDODL(const DKPidXDODL& aDKPidXDODL);
   virtual ~DKPidXDODL();
 

Member functions

operator =
Assignment operator.
   DKPidXDODL& operator= (DKPidXDODL& aDKPidXDODL);
 

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.
   virtual DKString getPrimaryId();
 

setPrimaryId
Sets the datastore specific primary persistent ID.
   virtual void setPrimaryId(const char* primaryId);
 

getPartId
Returns the part ID from the PID.
   unsigned long getPartId();
 

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

isSet
Returns TRUE if all fields of the PID have been specified.
   virtual DKBoolean isSet() const;
 

getRepType
Gets the representation type of the part.
   DKString getRepType();
 

setRepType
Sets the representation type of the part.
   void setRepType(const char*  aRType );
 

getItemId
Gets the Item ID.
   DKString getItemId();
 

setItemId
Sets the Item ID.
   void setItemId(const char*  aItemId );
 

clone
Returns a copy of the PID.
   virtual DKPid*  clone();
 

pidType
Gets the PID type.
   virtual DKString pidType() const;
 

Exceptions:

DKUsageError -- The following are possible error messages:

PID string invalid
The input string supplied to the DKPidXDODL constructor is not valid or it has an incorrect format.

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