Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKSMSCollectionDefICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKSMSCollectionDefICM
All Implemented Interfaces:
DKMessageId, DKMessageIdICM

public class DKSMSCollectionDefICM
extends java.lang.Object
implements DKMessageIdICM

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.


Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdICM
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKSMSCollectionDefICM()
          Default constructor
DKSMSCollectionDefICM(java.lang.String smsCollName)
          Constructs a new DKSMSCollectionDefICM object with a given name for the resource manager SMS collection
DKSMSCollectionDefICM(java.lang.String smsCollName, short smsCollCode, short rmCode, short sPrefetchInd, java.lang.String userid, java.lang.String createdTime)
          Constructor: this is a convenient constructor where all the metedata for this object are set during the construction
 
Method Summary
 void addReplica(DKRMSMSPairDefICM pairDef)
          Adds a replica with a given RM code and resource manager SMS collection code.
 void addReplica(short rmCode, short smsCode)
          Adds a replica with a given RM code and resource managerSMS collection code.
 void delReplica(DKRMSMSPairDefICM pairDef)
          Deletes a replica with a given RM code and SMS code.Memory function only.
 void delReplica(short rmCode, short smsCode)
          Deletes a replica with a given RM code and SMS code.
 dkAdminDomainDef getAdminDomain()
          Gets the administrative domain to which this resource manager SMS collection is assigned to
 java.lang.String getCreatedTime()
          Gets the timestamp when this resource manager SMS collection was created or last updated.
 java.lang.String getName()
          Gets the name of this resource manager SMS collection
 short getPrefetchInd()
          Gets whether this resource manager SMS collection is enabled for prefetch
 short getRMCode()
          Gets the resource manager identifier to which this resource manager SMS collection is assigned to
 short getSMSCollectionCode()
          Gets the resource manager SMS collection code This is the identifier that is assigned by the ICM datastore when the resource manager SMS collection is created.
 java.lang.String getUserid()
          Gets the userid who created or last updated this resource manager SMS collection
 dkCollection listReplica()
          Gets a list of replica for this resource manager SMS collection.
 void setAdminDomain(dkAdminDomainDef domain)
          Sets the administrative domain to which this resource manager SMS collection is assigned to.
 void setName(java.lang.String name)
          Sets the name of the resource manager SMS collection
 void setPrefetchInd(short sPrefetchInd)
          Sets the whether this resource manager SMS collection can be enabled for prefetch.
 void setRMCode(short rmCode)
          Sets the resource manager identifier to which this resource manager SMS collection is assigned to
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKSMSCollectionDefICM

public DKSMSCollectionDefICM()
Default constructor

DKSMSCollectionDefICM

public DKSMSCollectionDefICM(java.lang.String 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

public DKSMSCollectionDefICM(java.lang.String smsCollName,
                             short smsCollCode,
                             short rmCode,
                             short sPrefetchInd,
                             java.lang.String userid,
                             java.lang.String createdTime)
Constructor: 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 - Flag that indicates whether this SMS collection is used as a prefetch co
userid - default userid The user id who created or last updated this SMS collection.
createdTime - timeThe timestamp when this SMS collection was created or last updated
Method Detail

setName

public void setName(java.lang.String name)
Sets the name of the resource manager SMS collection
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.

getName

public java.lang.String getName()
Gets the name of this resource manager SMS collection
Returns:
name of the resource manager SMS collection

getSMSCollectionCode

public short getSMSCollectionCode()
Gets the resource manager SMS collection code This is the identifier that is assigned by the ICM datastore when the resource manager SMS collection is created.
Returns:
resource manager SMS collection code.

setPrefetchInd

public void setPrefetchInd(short sPrefetchInd)
Sets the whether this resource manager SMS collection can be enabled for prefetch.
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.

getPrefetchInd

public short getPrefetchInd()
Gets whether this resource manager SMS collection is enabled for prefetch
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

setRMCode

public void setRMCode(short rmCode)
Sets the resource manager identifier to which this resource manager SMS collection is assigned to
Parameters:
rmCode - resource manager identifier

getRMCode

public short getRMCode()
Gets the resource manager identifier to which this resource manager SMS collection is assigned to
Returns:
resource manager code

getUserid

public java.lang.String getUserid()
Gets the userid who created or last updated this resource manager SMS collection
Returns:
the userid who created or last updated this resource manager SMS collection

getCreatedTime

public java.lang.String getCreatedTime()
Gets the timestamp when this resource manager SMS collection was created or last updated.
Returns:
the time when this SMS collection was created or last updated

setAdminDomain

public void setAdminDomain(dkAdminDomainDef domain)
Sets the administrative domain to which this resource manager SMS collection is assigned to.
Parameters:
domain - the administrative domain to which this SMS collection is assigned to

getAdminDomain

public dkAdminDomainDef getAdminDomain()
Gets the administrative domain to which this resource manager SMS collection is assigned to
Returns:
administrative domain that this SMS collection is assigned to

addReplica

public void addReplica(short rmCode,
                       short smsCode)
                throws DKAlreadyExistException,
                       DKException,
                       java.lang.Exception
Adds a replica with a given RM code and resource managerSMS collection code. Memory function only. Please use DKRMConfigurationMgmtICM class to persist the data in the system persitantly add it to the system.
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.
DKException - when error occurs in the server
java.lang.Exception - when communication error occurs

addReplica

public void addReplica(DKRMSMSPairDefICM pairDef)
                throws DKAlreadyExistException,
                       DKException,
                       java.lang.Exception
Adds a replica with a given RM code and resource manager SMS collection code. Memory function only. Please use DKRMConfigurationMgmtICM class to persist in the system
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.
DKException - when error occurs in the server
java.lang.Exception - when communication error occurs

delReplica

public void delReplica(short rmCode,
                       short smsCode)
                throws DKNotExistException,
                       DKException,
                       java.lang.Exception
Deletes a replica with a given RM code and SMS code. Memory function only. Please use DKRMConfigurationMgmtICM class to persist in the system
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.
DKException - when error occurs in the server
java.lang.Exception - when communication error occurs

delReplica

public void delReplica(DKRMSMSPairDefICM pairDef)
                throws DKNotExistException,
                       DKException,
                       java.lang.Exception
Deletes a replica with a given RM code and SMS code.Memory function only. Please use DKRMConfigurationMgmtICM class to persist in the system
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.
DKException - when error occurs in the server
java.lang.Exception - when communication error occurs

listReplica

public dkCollection listReplica()
                         throws DKException
Gets a list of replica for this resource manager SMS collection.
Returns:
a dkCollection of DKRMSMSPairDefICM
Throws:
DKException - when error occurs in the server

EIP Java APIs

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