Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKStorageManageInfoIP

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

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

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

See Also:
Serialized Form

Constructor Summary
DKStorageManageInfoIP()
          Constructs a new DKStorageManageInfoIP object.
DKStorageManageInfoIP(DKStorageManageInfoIP sourceSMSIP)
          Copy constructor to construct a DKStorageManageInfoIP object.
 
Method Summary
 java.lang.String getCollectionName()
          Gets the collection name to be used during document creation.
 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 Object Access Method retains the document image.
 java.lang.String getStorageClass()
          Gets the name of the storage class in which an object is stored.
 java.lang.String getStoreSite()
          Gets the symbolic name of the ODM host that stores the documents.
 void setCollectionName(java.lang.String aCollectionName)
          Sets the collection name to be used during document creation.
 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 Object Access Method retains the document image.
 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 4-character symbolic name of the ODM host that stores the documents.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKStorageManageInfoIP

public DKStorageManageInfoIP()
Constructs a new DKStorageManageInfoIP object.

DKStorageManageInfoIP

public DKStorageManageInfoIP(DKStorageManageInfoIP sourceSMSIP)
Copy constructor to construct a DKStorageManageInfoIP object.
Parameters:
sourceSMSIP - a source DKStorageManageInfoIP 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 Object Access Method retains the document image. The valid values range from 1 to 999999999. Note: For IP/390 this value is used when the document is created. See DKDatastoreIP.addObject for more information.
Parameters:
aRetention - the retention days

getRetention

public int getRetention()
Gets the period in days that the Object Access Method retains the document image.
Returns:
the retention days

setCollectionName

public void setCollectionName(java.lang.String aCollectionName)
Sets the collection name to be used during document creation. The collection name consists of the storage group, management class, and storage class separated by periods (.). Note: For IP/390 this value is used when the document is created. See DKDatastoreIP.addObject for more information.
Specified by:
setCollectionName in interface dkStorageManageInfo
Parameters:
aCollectionName - the collection name

getCollectionName

public java.lang.String getCollectionName()
Gets the collection name to be used during document creation. The collection name consists of the storage group, management class, and storage class separated by periods (.).
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 management class defines backup, retention and class characteristics of the document. Note: For IP/390 this value is used when the document is created. See DKDatastoreIP.addObject for more information.
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. The management class defines backup, retention and class characteristics of the document.
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 storage class defines the different levels of performance and availability of the document. Note: For IP/390 this value is used when the document is created. See DKDatastoreIP.addObject for more information.
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. The storage class defines the different levels of performance and availability of the document.
Specified by:
getStorageClass in interface dkStorageManageInfo
Returns:
the storage class name

setStoreSite

public void setStoreSite(java.lang.String aStoreSite)
Sets the 4-character symbolic name of the ODM host that stores the documents. Note: For IP/390 this value is used when the document is created. See DKDatastoreIP.addObject for more information.
Specified by:
setStoreSite in interface dkStorageManageInfo
Parameters:
aStoreSite - an object server name

getStoreSite

public java.lang.String getStoreSite()
Gets the symbolic name of the ODM host that stores the documents.
Returns:
the object server name

EIP Java APIs

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