Index

DKDatastoreExtOD

Purpose:

DKDatastoreExtOD is the implementation class of OnDemand datastore extension object.

Class summary:

class DKEXPORT DKDatastoreExtOD: public dkDatastoreExt
{  
    public:
    DKDatastoreExtOD();
    DKDatastoreExtOD(dkDatastore* ds);
    virtual ~DKDatastoreExtOD() ;
 
    virtual void        setName(const char* extName);
    virtual DKString    getName() const;
    virtual DKBoolean   isSupported(const char* functionName);
    virtual DKString*   listFunctions(long& arraySize);
    virtual void        addToFolder(dkDataObject* folder, dkDataObject* member);
    virtual void        removeFromFolder(dkDataObject* folder, dkDataObject* member);
    virtual DKBoolean   isCheckedOut(dkDataObject* item);
    virtual DKString    checkedOutUserid(dkDataObject* item);
    virtual void        unlockCheckedOut(dkDataObject* item);
    virtual void        checkOut(dkDataObject* item);
    virtual void        checkIn(dkDataObject* item);
 
    virtual DKCommonPrivilege* getCommonPrivilege();
    virtual DKCommonPrivilege* getCommonPrivilege(dkDataObject* item);
 
    virtual dkXDO*      retrieveFormOverlay(const char* id);
    virtual void        moveObject(dkDataObject* ddo, const char* entityName);
 
    dkDatastore*        getDatastore();
    void                setDatastore(dkDatastore* ds);
};

Members:

Constructors and destructor
The first constructor is the default constructor for DKDatastoreExtOD. The second constructor constructs a DKDatastoreExtOD for a given datastore object. DKDatastoreExtOD();
    DKDatastoreExtOD(dkDatastore* ds);
virtual ~DKDatastoreExtOD() ;
 
 
 
 

Member functions

getDatastore
Gets the reference to the owner datastore object.
   dkDatastore* getDatastore();
 
 

setDatastore
Sets the reference to the owner datastore object.
  void setDatastore(dkDatastore* ds);

getName
Gets the name of this extension object.
    
virtual DKString getName() const;
 
 

setName
Sets the name of this extension object. This operation is not supported, because you cannot change the datastore standard extension name.
virtual void setName(const char* extName);

isSupported
Queries to see if the given function name is supported by this extension.
   
virtual DKBoolean isSupported(const char* functionName);
 
 

listFunctions
Lists all supported function names from this extension.
   
virtual DKString* listFunctions(long& arraySize);

addToFolder
This function is not supported.
   
virtual void addToFolder(dkDataObject* folder, dkDataObject* member);
 

removeFromFolder
This function is not supported.
 
virtual void removeFromFolder(dkDataObject* folder, dkDataObject* member);
 
 

checkOut
This function is not supported.
   
virtual void checkOut(dkDataObject* item);
 
 

checkIn
This function is not supported.
   
virtual void checkIn(dkDataObject* item);
 
 

isCheckedOut
This function is not supported.
   
virtual DKBoolean isCheckedOut(dkDataObject* item);
 
 

checkedOutUserid
This function is not supported.
   
virtual DKString checkedOutUserid(dkDataObject* item);
 
 

unlockCheckedOut
This function is not supported.
   
virtual void unlockCheckedOut(dkDataObject* item);
 
 

getCommonPrivilege
The first form without a parameter attempts to get the commmon privilege of the OnDemand datastore and it is not supported. The second form gets the commmon privilege of a specific dkDataObject or DDO and it is fully supported by the OnDemand datastore.
   
virtual DKCommonPrivilege* getCommonPrivilege();
 
virtual DKCommonPrivilege* getCommonPrivilege(dkDataObject* item);
 
 

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