Purpose:
Persistent identifier (PID) provides a unique identifier to locate the persistent data of data objects in a set of known datastores. A dkDataObject needs to have a PID in order to store its data persistently.
Class summary:
class DKPid { public: DKPid(); DKPid(long idStringCount); DKPid(const char* fromPidString); DKPid(const DKPid& fromPid); virtual ~DKPid(); DKPid& operator= (const DKPid& fromPid); virtual DKString getDatastoreType() const; virtual void setDatastoreType(const char * fromDatastoreType); virtual DKString getDatastoreName() const; virtual void setDatastoreName(const char * fromDatastoreName); virtual DKString getId() const; virtual void setId(const char* fromId); virtual DKString getIdString(); virtual void setIdString(const char* idStr); virtual DKString getPrimaryId(); virtual void setPrimaryId(const char* primaryId); virtual DKString pidString(); virtual DKString getObjectType() const; virtual void setObjectType(const char * fromObjectType); virtual DKBoolean isSet() const; virtual long getIdStringCount(); virtual void setIdStringCount(long idStringCount); virtual DKString getIdString(long index); virtual void setIdString(long index, const char* idStringItem); virtual DKPid* clone(); virtual DKString pidType() const; };
Members:
DKPid(); DKPid(long idStringCount); DKPid(const char* fromPidString); DKPid(const DKPid& fromPid); virtual ~DKPid();
The first two constructors construct a persistent identifier (PID) object. The third constructor constructs a PID from a PID string representation. The fourth constructor constructs a PID from another PID.
Parameters
DKPid& operator= (const DKPid& fromPid);
virtual DKString getDatastoreType() const;
virtual void setDatastoreType(const char * fromDatastoreType);
virtual DKString getDatastoreName() const;
virtual void setDatastoreName(const char * fromDatastoreName);
virtual DKString getId() const;
virtual void setId(const char* fromId);
virtual DKString getIdString();
Parameters
idStr -- The datastore persistent ID.
virtual void setIdString(const char* idStr);
virtual DKString getPrimaryId();
virtual void setPrimaryId(const char* primaryId);
virtual DKString pidString();
virtual DKString getObjectType() const;
Parameters
fromObjectType -- The object type.
virtual void setObjectType(const char * fromObjectType);
virtual DKBoolean isSet() const;
virtual long getIdStringCount();
virtual void setIdStringCount(long idStringCount);
Parameters
index -- The index of a part of the ID string.
virtual DKString getIdString(long index);
Parameters
index -- The index of a part of the ID string.
idStringItem -- A part of the ID string.
virtual void setIdString(long index, const char* idStringItem);
virtual DKPid* clone();
virtual DKString pidType() const;
Exceptions:
DKUsageError -- The following are possible error messages:
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.