Index

DKDatastoreExtV4

Purpose:

DKDatastoreExtV4 is the implementation class of VisualInfo for AS/400 datastore extension object.

Class summary:

class DKDatastoreExtV4: public dkDatastoreExt
{
  public:
    DKDatastoreExtV4(); 
    DKDatastoreExtV4(dkDatastore* ds); 
    virtual ~DKDatastoreExtV4();
 
    virtual void setName(const char* extName);
    virtual DKString getName() const;    
    dkDatastore* getDatastore();
    void         setDatastore(dkDatastore* ds);
    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();
};

Members:

Constructors and destructor
The first constructor is the default constructor. The second constructor constructs a DKDatastoreExtV4 for a given datastore object.

    DKDatastoreExtV4(); 
    DKDatastoreExtV4(dkDatastore* ds); 
    virtual ~DKDatastoreExtV4();
 

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);
 

setName
Sets the name of the extension object.
    virtual void setName(const char* extName);
 

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

isSupported
Queries 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
Adds a new member item to this folder and reflects the results immediately in the datastore (that is, it makes it persistent). In VisualInfo for AS/400, the member must exist in the datastore before it can be added to a folder.
    virtual void addToFolder(dkDataObject* folder, 
                                    dkDataObject* member);
 

removeFromFolder
Removes a member from this folder and reflects the results immediately in the datastore (that is, it make it persistent). At the end of the operation, the member object will not be in this DKFolder collection in memory, and it will also be removed from the persistent folder representation in the datastore.
    virtual void removeFromFolder(dkDataObject* folder, 
                                  dkDataObject* member);
 

checkOut
Checks out a document or folder item from the datastore. The current user has exclusive updating privileges to the item, while other users are allowed read-only access until the current user checks it back in.
    virtual void checkOut(dkDataObject* item);
 

checkIn
Checks in a document or folder item previously checked out from the datastore. This releases all write privileges to this item.
    virtual void checkIn(dkDataObject* item);
 

getCommonPriviledge
Gets the commmon privilege of a specific datastore.
    virtual DKCommonPrivilege* getCommonPrivilege();
 

isCheckedOut
Checks if a document or folder item was checked out from the datastore.
    virtual DKBoolean isCheckedOut(dkDataObject* item);
 

checkedOutUserid
Gets the user ID that checked out the item from the datastore.
    virtual DKString checkedOutUserid(dkDataObject* item);
 

unlockCheckedOut
Unlocks the item from the datastore.
    virtual void unlockCheckedOut(dkDataObject* item);
 

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