Index

DKPidXDOOD

Purpose:

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

Heirarchy:
dkPid dkPidXDO dkPidXDOOD

Class summary:

class DKEXPORT DKPidXDOOD : public DKPidXDO
{  
   public:
  DKPidXDOOD();
  DKPidXDOOD(const char * aPidString);
  DKPidXDOOD(const DKPidXDOOD& aDKPidXDOOD);
  virtual ~DKPidXDOOD();
 
  DKPidXDOOD& operator= (DKPidXDOOD& aDKPidXDOOD);
 
  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;
 
  void setType(long type);
  long getType();
};

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 DKPidXDOOD(); DKPidXDOOD(const char * aPidString); DKPidXDOOD(const DKPidXDOOD& aDKPidXDOOD); virtual ~DKPidXDOOD();

Member functions

operator =
Assignment operator.
DKPidXDOOD& operator= (DKPidXDOOD& aDKPidXDOOD);
 
 

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
unsigned long getPartId();
  virtual DKString getId() const; 

setPartId
Sets the part ID of the PID.
  vvoid 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.
  vDKString 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; 

getId
getId has been deprecated and replaced by getPrimaryId.
  virtual DKString getId() const; 

getType
This function is not supported.
  DKString getRepType(); 

setType
This function is not supported.
  void setRepType(const char*  aRType ); 

Exceptions:
DKUsageError -- The following are possible error messages:
  PID string invalid 
The input string supplied to the DKPidXDOOD constructor is not valid or it has an incorrect format. 
 

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