Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKStorageManageInfoICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKStorageManageInfoICM
All Implemented Interfaces:
dkExtension, dkStorageManageInfo, java.io.Serializable

public class DKStorageManageInfoICM
extends java.lang.Object
implements dkStorageManageInfo, java.io.Serializable

Use this class to define the system managed storage information assoicated with a resource in ICM datastore.

See Also:
Serialized Form

Constructor Summary
DKStorageManageInfoICM()
          Constructs a new DKStorageManageInfoICM object and initialize the name of this extension to "DKStorageManageInfoICM".
DKStorageManageInfoICM(DKStorageManageInfoICM sourceSMSDL)
          Copy constructor to construct a DKStorageManageInfoICM object.
 
Method Summary
 java.lang.String getCollectionName()
          Gets the user-defined SMS collection name where the resource is stored..
 java.lang.String getExpirationDate()
          Gets the number of days the resource is maintained in the ICM datstore.
 java.lang.String getManagementClass()
          Gets the name of the management class of the resource.
 java.lang.String getName()
          Gets the name of this extension object
 java.lang.String getStorageClass()
          Gets the name of the storage class on which the resource is stored.
 java.lang.String getStoreSite()
          Gets the name of the resource manager in which a resource is stored.
 void setCollectionName(java.lang.String aCollectionName)
          Sets the name of the user-defined SMS collection where the resource is stored.
 void setExpirationDate(java.lang.String expirationTime)
          Sets the period in days until which the ICM datastore retains the resource in the resource manager.
 void setManagementClass(java.lang.String aMgtClass)
          Sets the name of the SMS management class for the resource.
 void setName(java.lang.String extName)
          Sets the name of this extension object
 void setStorageClass(java.lang.String aStgClass)
          Sets the name of the storage class on which the resource is stored.
 void setStoreSite(java.lang.String aStoreSite)
          Sets the name of the resource manager in which an resource is stored.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKStorageManageInfoICM

public DKStorageManageInfoICM()
Constructs a new DKStorageManageInfoICM object and initialize the name of this extension to "DKStorageManageInfoICM".

DKStorageManageInfoICM

public DKStorageManageInfoICM(DKStorageManageInfoICM sourceSMSDL)
Copy constructor to construct a DKStorageManageInfoICM object. The extension name is not copied and it is set to "DKStorageManageInfoICM".
Parameters:
sourceSMSDL - a source DKStorageManageInfoICM object whose copy is made.
Method Detail

getName

public java.lang.String getName()
                         throws java.lang.Exception
Gets the name of this extension object
Specified by:
getName in interface dkExtension
Returns:
name of this object

setName

public void setName(java.lang.String extName)
             throws java.lang.Exception
Sets the name of this extension object
Specified by:
setName in interface dkExtension
Parameters:
extName - name of this extension object

setExpirationDate

public void setExpirationDate(java.lang.String expirationTime)
Sets the period in days until which the ICM datastore retains the resource in the resource manager.
Parameters:
expiration - days after which the the resource expires.

getExpirationDate

public java.lang.String getExpirationDate()
Gets the number of days the resource is maintained in the ICM datstore.
Returns:
the retention days

setCollectionName

public void setCollectionName(java.lang.String aCollectionName)
Sets the name of the user-defined SMS collection where the resource is stored. The SMS collection name can be up to 44 characters. Note: the SMS collection should be defined and valid on the resource manager.
Specified by:
setCollectionName in interface dkStorageManageInfo
Parameters:
aCollectionName - a user-defined SMS collection name

getCollectionName

public java.lang.String getCollectionName()
Gets the user-defined SMS collection name where the resource is stored..
Specified by:
getCollectionName in interface dkStorageManageInfo
Returns:
the SMS collection name

setManagementClass

public void setManagementClass(java.lang.String aMgtClass)
Sets the name of the SMS management class for the resource. The name must be valid on the resource manager server where the resource is stored. By default the ICM datastore will use the first storage class in the SMS collection. The value of the management class is set by the system using this method. The user is not allowed to change this value.
Specified by:
setManagementClass in interface dkStorageManageInfo
Parameters:
aMgtClass - a management class name

getManagementClass

public java.lang.String getManagementClass()
Gets the name of the management class of the resource.
Specified by:
getManagementClass in interface dkStorageManageInfo
Returns:
the management class name

setStorageClass

public void setStorageClass(java.lang.String aStgClass)
Sets the name of the storage class on which the resource is stored. The name must be valid on the resource manager where the resource is stored. By default the ICM datastore will use the first storage class in the SMS collection. The value of the storage class is set by the system using this method. The user is not allowed to change this value.
Specified by:
setStorageClass in interface dkStorageManageInfo
Parameters:
aStgClass - a storage class name. The storage class name can be up to 32 characters.

getStorageClass

public java.lang.String getStorageClass()
Gets the name of the storage class on which the resource is stored.
Specified by:
getStorageClass in interface dkStorageManageInfo
Returns:
the storage class name

setStoreSite

public void setStoreSite(java.lang.String aStoreSite)
Sets the name of the resource manager in which an resource is stored. After a resource is stored in the resource manager, you can not move it to another resource manager using this function.
Specified by:
setStoreSite in interface dkStorageManageInfo
Parameters:
aStoreSite - name of the resource manager where the resource is stored. This string can be up to 128 characters.

getStoreSite

public java.lang.String getStoreSite()
Gets the name of the resource manager in which a resource is stored.
Returns:
the resource manager name

EIP Java APIs

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