Index

DKRMSMSPairDefICM

Purpose:

The DKRMSMSPairDefICM class is a utility class that supports DKSMSCollectionDefICM class. Use the DKRMSMSPairDefICM class to pair a resource manager and SMS collection to which it belongs.

Since: Version 8

Class summary:

class DKEXPORT DKRMSMSPairDefICM
{
public:
                      DKRMSMSPairDefICM();
                      DKRMSMSPairDefICM(const DKRMSMSPairDefICM& smsPair);
                         DKRMSMSPairDefICM(const char* rmName, const char* smsName);
                      DKRMSMSPairDefICM(short rmCode, short smsCode);
                      ~DKRMSMSPairDefICM();
        DKString      getRMName();
        void          setRMName(const char* rmName);
        short         getRMCode();
        void          setRMCode(short rmCode);
        DKString      getSMSName();
        void          setSMSName(const char* smsName);
        short         getSMSCode();
        void          setSMSCode(short smsCode);
};

Members:

Constructors and destructor
DKRMSMSPairDefICM()

Default constructor. The resource manager and SMS collection names is set to an empty string and their respective codes are set to 0.

DKRMSMSPairDefICM(const char* rmName, const char* smsName)

Constructs an object with resource manager identifier code and SMS collection identifier code.

Parameters: rmcode - resource manager code smscode - resource manager collection code Copy Constructor

DKRMSMSPairDefICM(const DKRMSMSPairDefICM& smsPair)

Copy constructor for the attribute definition object related to the ICM datastore.

Parameters: smspair - attribute definition object that is used as a creation template Destructor

~DKRMSMSPairDefICM()

Destructor for this object.

Member functions

getRMName
Gets the resource manager name.

Returns: The resource manager name

DKString getRMName();

setRMName
Sets the resource manager name. The resource manager name can be up to 128 characters.

Parameters: rmName - source resource manager name

Throws: DKException if tries to delete an attribute that already associates with an item type or delete an attribute that does not exist in the persistent store

void setRMName(const char* rmName);

getRMCode
Gets the resource manager identifier code. This code is assigned by the ICM datastore when the resource manager is created.

Returns: the resource manager code

Throws: DKException if tries to delete an attribute that already associates with an item type or delete an attribute that does not exist in the persistent store

short getRMCode();

setRMCode
Sets the resource manager identifier code with the code that was assigned by the ICM datastore. Note: This code cannot be a random number and should match the code assigned by the ICM datastore.

Parameters: rmCode - resource manager code

void setRMCode(short rmCode);

getSMSName
Gets the resource manager SMS collection name.

Returns: resource manager SMS collection name

DKString getSMSName();

setSMSName
Sets the resource manager SMS collection name.

Parameters: smsName - resource manager SMS collection name

void setSMSName(const char* smsName);

getSMSCode
Gets the resource manager SMS collection identifier code. This code is assigned by the ICM datastore when the SMS collection is created.

Returns: source SMS collection code

short getSMSCode();

setSMSCode
Sets the source resource managerSMS collection cCode with the code that was assigned by the ICM datastore. Note: This code cannot be a random number and should match the code assigned by the ICM datastore.

Parameters: smsCode - resource manager SMS collection code

short getSMSCode();

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