Index

DKStorageManageInfoOD

Purpose:

This class contains the information necessary to support the system-managed storage (SMS) for an object on a variety of object servers. It is included to adhere the OO API framework standard. The functions included are not supported.

Heirarchy:
dkExtension dkStorageManageInfo DKStorageManageInfoOD

Class summary:

class DKEXPORT DKStorageManageInfoOD: public dkStorageManageInfo
 
{  
   public:
   DKStorageManageInfoOD();
   DKStorageManageInfoOD(const DKStorageManageInfoOD& aDKSMSInfoOD);
   virtual ~DKStorageManageInfoOD();
 
   DKStorageManageInfoOD& operator= (const DKStorageManageInfoOD& aDKSMSInfoOD);
   DKBoolean   operator==(const DKStorageManageInfoOD& aDKSMSInfoOD) const;
   long        getRetention() const;
   void        setRetention(const long  aRetention);
   DKString    getCollectionName() const;
   void        setCollectionName(const char* aCollectionName);
   DKString    getManagementClass() const;
   void        setManagementClass(const char* aMgtClass);
   DKString    getStorageClass() const;
   void        setStorageClass(const char* aStgClass);
   DKString    getStoreSite() const;
   void        setStoreSite(const char* aStoreSite);
};

Members:

Constructors and destructor
Constructs a new DKStorageManageInfoOD object. Copy constructor to construct a DKStorageManageInfoOD object.
  DKStorageManageInfoOD();
DKStorageManageInfoOD(const DKStorageManageInfoOD& aDKSMSInfoOD);
virtual ~DKStorageManageInfoOD();
 
 

Member functions

getServerType
Gets the server type.
  DKString getServerType();
 
 

operator=
Assignment operator.
  DKStorageManageInfoOD& operator= (DKStorageManageInfoOD& aDKStorageManageInfoOD);
 
 

operator==
Use this function to compare the object to the given parameter object; return TRUE if both objects have the same value for each data member.
  DKBoolean operator==(const DKStorageManageInfoOD& aDKStorageManageInfoOD) const;
 

setRetention
Sets the period in days that the OnDemand system retains the object in system-managed storage. The valid values range from 1 to 999999999. The default value is 30.
  void setRetention(const long  aRetention);
 

getRetention
Sets the ASCIIZ user-defined collection name. This character string provides a meaningful name for the collection already been created. It can be up to 44 characters. The name must be valid on the object server where you store the object.
  long getRetention() const;
 
 

getCollectionName
Get the ASCIIZ collection name of this object.
  DKString  getCollectionName() const;
 
 

setCollectionName
Sets the ASCIIZ user-defined collection name. This character string provides a meaningful name for the collection already been created. It can be up to 44 characters. The name must be valid on the object server where you store the object.
  void  setCollectionName(const char* aCollectionName);
 

setManagementClass
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 OnDemand system uses the default management class for the collection.
  void  setManagementClass(const char* aMgtClass);
 

getManagementClass
Get the name of the management class in which an object is stored. If not specified the default value NULL will be passed to OD.
  DDKString  getManagementClass() const;
 

setStorageClass
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 OnDemand system uses the default initial storage class name of the collection.
  void  setStorageClass(const char* aStgClass);
 

getStorageClass
Get the name of the storage class in which an object is stored. If not specified the default value NULL will be passed to OD.
 DKString  getStorageClass() const; 

setStoreSite
This function is not supported.
  void  setStoreSite(const char* aStoreSite);
 
 

getStoreSite
This function is not supported.
 DKString  getStoreSite() const; 

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