Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKStorageManageInfoDL

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

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

This class defines the DL system-managed storage (SMS) informations.

See Also:
Serialized Form

Constructor Summary
DKStorageManageInfoDL()
          Constructs a new DKStorageManageInfoDL object.
DKStorageManageInfoDL(DKStorageManageInfoDL sourceSMSDL)
          Copy constructor to construct a DKStorageManageInfoDL object.
 
Method Summary
 java.lang.String getCollectionName()
          Gets the user-defined collection name.
 java.lang.String getManagementClass()
          Gets the name of the management class in which an object is stored.
 java.lang.String getName()
          Gets the name of this extension object
 int getRetention()
          Gets the period in days that the DL system retains the object in system-managed storage.
 java.lang.String getStorageClass()
          Gets the name of the storage class in which an object is stored.
 java.lang.String getStoreSite()
          Gets the name of the object server in which an object is stored.
 void setCollectionName(java.lang.String aCollectionName)
          Sets the ASCIIZ user-defined collection name.
 void setManagementClass(java.lang.String aMgtClass)
          Sets the name of the management class in which an object is stored.
 void setName(java.lang.String extName)
          Sets the name of this extension object
 void setRetention(int aRetention)
          Sets the period in days that the DL system retains the object in system-managed storage.
 void setStorageClass(java.lang.String aStgClass)
          Sets the name of the storage class in which an object is stored.
 void setStoreSite(java.lang.String aStoreSite)
          Sets the name of the object server in which an object is stored.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKStorageManageInfoDL

public DKStorageManageInfoDL()
Constructs a new DKStorageManageInfoDL object.

DKStorageManageInfoDL

public DKStorageManageInfoDL(DKStorageManageInfoDL sourceSMSDL)
Copy constructor to construct a DKStorageManageInfoDL object.
Parameters:
sourceSMSDL - a source DKStorageManageInfoDL object
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

setRetention

public void setRetention(int aRetention)
Sets the period in days that the DL system retains the object in system-managed storage. The valid values range from 1 to 999999999.
Parameters:
aRetention - the retention days

getRetention

public int getRetention()
Gets the period in days that the DL system retains the object in system-managed storage.
Returns:
the retention days

setCollectionName

public void setCollectionName(java.lang.String aCollectionName)
Sets the ASCIIZ user-defined collection name. This character string provides a meaningful name for the collection already created. It can be up to 44 characters. The name must be valid on the object server where you store the object.
Specified by:
setCollectionName in interface dkStorageManageInfo
Parameters:
aCollectionName - a user-defined collection name

getCollectionName

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

setManagementClass

public void setManagementClass(java.lang.String aMgtClass)
Sets the name of the management class in which an object is stored. The name must be valid on the object server where you store the object. If this field contains the value NULL when the object is assigned, the Digital Library system uses the default management class for the collection.
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 in which an object is stored.
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 in which an object is stored. The name must be valid on the object server where you store the object. If this field contains the value NULL when the object is assigned, the Digital Library system uses the default initial storage class name of the collection.
Specified by:
setStorageClass in interface dkStorageManageInfo
Parameters:
aStgClass - a storage class name

getStorageClass

public java.lang.String getStorageClass()
Gets the name of the storage class in which an object 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 object server in which an object is stored. After an object is stored in the object server, you can not move it to another object server using this function.
Specified by:
setStoreSite in interface dkStorageManageInfo
Parameters:
aStoreSite - an object server name

getStoreSite

public java.lang.String getStoreSite()
Gets the name of the object server in which an object is stored.
Returns:
the object server name

EIP Java APIs

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