Index

dkDatastoreExt

Purpose:

This is the class that is used to represent a datastore extension object.

Class summary:

 class dkDatastoreExt: public dkExtension
{
   public:
     virtual ~dkDatastoreExt();
     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 void addChild(dkDataObject* parent, dkDataObject* child);
     virtual void removeChild(dkDataObject* parent, dkDataObject* child);
     virtual void addLink(DKLink* link);
     virtual void removeLink(DKLink* link);
     virtual void removeLinks(dkCollection* linkCollection);
     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);
     virtual void moveObject(dkDataObject* srcDataObject, dkDataObject* destDataObject, long options);
     virtual void changePassword(const char* userId, const char* oldPwd, const char* newPwd);
     virtual void addPart(dkDataObject* parent, dkXDO* part);
     virtual void removePart(dkDataObject* parent, dkXDO* part);
   protected:
     dkDatastoreExt(); 
 }

Members:

Constructors and destructor
dkDatastoreExt();
virtual ~dkDatastoreExt();

Member functions

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

listFunctions
Lists all functions supported by this extension.
virtual DKString* listFunctions(long& arraySize);

addToFolder
Adds member to folder.
virtual void addToFolder(dkDataObject* folder, dkDataObject* member);

Note:
DKUsageError exception thrown if method is not implemented.

removeFromFolder
Removes an member from folder.
virtual void removeFromFolder(dkDataObject* folder, dkDataObject* member);

Note:
DKUsageError exception thrown if method is not implemented.

isCheckedOut
Returns TRUE if data object is checked out.
virtual DKBoolean isCheckedOut(dkDataObject* item);

Note:
DKUsageError exception thrown if method is not implemented.

checkedOutUserid
Returns the user ID that has the data object checked out.
virtual DKString checkedOutUserid(dkDataObject* item);

Note:
DKUsageError exception thrown if method is not implemented.

checkOut
Checks out data object.
virtual void checkOut(dkDataObject* item);

Note:
DKUsageError exception thrown if method is not implemented.

checkIn
Checks in data object.
virtual void checkIn(dkDataObject* item);

Note:
DKUsageError exception thrown if method is not implemented.

getCommonPrivilege
Gets common privilege.
virtual DKCommonPrivilege* getCommonPrivilege();
virtual DKCommonPrivilege* getCommonPrivilege(dkDataObject* item);

Note:
DKUsageError exception thrown if method is not implemented.

addChild
Add a new child member to the parent in the datastore.
virtual void addChild(dkDataObject* parent, dkDataObject* child);

Note:
DKUsageError exception thrown if method is not implemented.

removeChild
Removes a child member from the parent in the datastore.
virtual void removeChild(dkDataObject* parent, dkDataObject* child);

Note:
DKUsageError exception thrown if method is not implemented.

addLink
Add a new link between a source and target item.
virtual void addLink(DKLink* link);

Note:
DKUsageError exception thrown if method is not implemented.

removeLink
Removes a link between a source and target item.
virtual void removeLink(DKLink* link);

Note:
DKUsageError exception thrown if method is not implemented.

removeLinks
Removes links between a source and target items.
virtual void removeLinks(dkCollection* linkCollection);

Note:
DKUsageError exception thrown if method is not implemented.

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

Note:
DKUsageError exception thrown if method is not implemented.

retrieveFormOverlay
Retrieves the form overlay object.
virtual dkXDO* retrieveFormOverlay(const char* id);

Note:
DKUsageError exception thrown if method is not implemented.

moveObject
Moves current dataobject from one entity to another.
virtual void moveObject(dkDataObject* ddo, const char* entityName);

Note:
DKUsageError exception thrown if method is not implemented.

moveObject
Moves current dataobject from one entity to another.
virtual void moveObject(dkDataObject* srcDataObject, dkDataObject* destDataObject, long options);

Note:
DKUsageError exception thrown if method is not implemented.

addPart
Add a part object.
virtual void addPart(dkDataObject* parent, dkXDO* part);

Note:
DKUsageError exception thrown if method is not implemented.

removePart
Remove a part object.
virtual void removePart(dkDataObject* parent, dkXDO* part);

Note:
DKUsageError exception thrown if method is not implemented.

changePassword
Changing password on the the server for the given userid.
virtual void changePassword(const char* userId, const char* oldPwd, const char* newPwd);

Note:
DKUsageError exception thrown if method is not implemented.

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