Purpose:
Use this class to represent a resource manager SMS collection in an ICM datastore. Use this class in conjunction with DKRMConfigurationDefICM to add, update, delete a resource manager SMS collection.
Since:Version 8
Class summary:
class DKEXPORT DKSMSCollectionDefICM { public: DKSMSCollectionDefICM(); DKSMSCollectionDefICM(const DKSMSCollectionDefICM& smsObj); DKSMSCollectionDefICM(const char* smsCollName); DKSMSCollectionDefICM(const char* smsCollName, short smsCollCode, short rmCode, short sPrefetchInd, const char* userid, const char* createdTime); ~DKSMSCollectionDefICM(); void setName(const char* name); DKString getName(); void setSMSCollectionCode(short smsCollCode); short getSMSCollectionCode(); void setPrefetchInd(short sPrefetchInd); short getPrefetchInd(); void setRMCode(short rmCode); short getRMCode(); void setUserid(const char* userid); DKString getUserid(); void setCreatedTime(const char* createTime); DKString getCreatedTime(); void setAdminDomain(DKAdminDomainDefICM* domain); DKAdminDomainDefICM* getAdminDomain(); void addReplica(short rmCode, short smsCode); void addReplica(DKRMSMSPairDefICM* pairDef); void delReplica(short rmCode, short smsCode); void delReplica(DKRMSMSPairDefICM* pairDef); dkCollection* listReplica(); dkCollection* getDeletedReplica(); dkCollection* getAddedReplica(); };
Members:
DKSMSCollectionDefICM()
Default constructor. Constructs an instance of SMS collection definition class.
DKSMSCollectionDefICM(const char* smsCollName)
Constructs a new DKSMSCollectionDefICM object with a given name for the resource manager SMS collection.
Parameters: smsCollName - name of the collection. The name can be up to 244 characters on NT, AIX and SUN workstation, and up to 44 characters on OS/390 system
DKSMSCollectionDefICM(const char* smsCollName, short smsCollCode, short rmCode, short sPrefetchInd, const char* userid, const char* createdTime)
This is a convenient constructor where all the metedata for this object are set during the construction.
Parameters: smsCollName - SMS collection name. The name can be up to 244 characters on NT, AIX and SUN workstation, and up to 44 characters on OS/390 system. smsCollCode - SMS collection code. This is the identifier code assigned to the collection by the ICM datastore. This value is overwritten if this object is used for creating the resource manager SMS collection. rmCode - resource manager code. The resource manager identifier to which this SMS collection belongs to. prefetchInd pre - flag that indicates whether this SMS collection is used as a prefetch code. userid - the user id who created or last updated this SMS collecton. createdTime - The timestamp when this SMS collection was created or last updated. Copy Constructor
DKSMSCollectionDefICM(const DKSMSCollectionDefICM& smsObj)
Copy constructor for the SMS collection object. The new instance of SMS collection definition class will contain all information copied from the original.
Parameters: smsObj -a SMS collection definition Destructor
~DKSMSCollectionDefICM()
Destructor for this object.
Parameters: name - name of the resource manager SMS collection. The name can be up to 244 characters on NT, AIX and SUN workstation, and up to 44 characters on OS/390 system.
void setName(const char* name);
Returns: name of the resource manager SMS collection
DKString getName();
Parameters: smsCollCode - resource manager collection code
void setSMSCollectionCode(short smsCollCode);
Returns: resource manager SMS collection code
short getSMSCollectionCode();
Parameters: sPrefetchInd - Set to a value of 1 to indicate that this SMS collection is used for prefetch. Set a value of 0 to indicate that this SMS collection is not used for prefetch Note: Prefetch is only supported in OS/390. PREFETCH IS NOT SUPPORTED FOR THIS RELEASE.
void setPrefetchInd(short sPrefetchInd);
Returns: a value of 1 to indicate that this SMS collection is used for prefetch. a value of 0 to indicate that this SMS collection is not used for prefetch
short getPrefetchInd();
Parameters: rmCode - resource manager identifier
void setRMCode(short rmCode);
Returns: resource manager code
short getRMCode();
void setUserid(const char* userid);
Returns: the userid who created or last updated this resource manager SMS collection
DKString getUserid();
Parameters: createTime - the created time
void setCreatedTime(const char* createTime);
Returns: the time when this SMS collection was created or last updated
DKString getCreatedTime();
Parameters: domain - the administrative domain to which this SMS collection is assigned to
void setAdminDomain(DKAdminDomainDefICM* domain);
Returns:
DKAdminDomainDefICM* getAdminDomain();
Parameters: rmCode - resource manager Code smsCode - SMS collection Code
Throws: DKAlreadyExistException - if the given RM code and SMS code pair is already a replica for this collection
void addReplica(short rmCode, short smsCode);
Parameters: pairDef - A DKRMSMSPairDefICM object which contains the resource manager and resource manager SMS collection pair
Throws: DKAlreadyExistException - if the given RM code and SMS code pair is already a replica for this collection
void addReplica(DKRMSMSPairDefICM* pairDef);
Parameters: rmCode - resource manager Code smsCode - SMS collection Code
Throws: DKNotExistException - if the given RM code and SMS code pair is not a replica for this collection
void delReplica(short rmCode, short smsCode)
Parameters: pairDef - A DKRMSMSPairDefICM object which contains the resource manager and resource manager SMS collection pair
Throws: DKNotExistException - if the given RM code and SMS code pair is not a replica for this collection
void delReplica(DKRMSMSPairDefICM* pairDef);
Returns: a dkCollection of DKRMSMSPairDefICM
Throws: DKException - if an error occurs
dkCollection* listReplica();
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.