|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Defines the interface for Datastore Standard Extension classes.
Method Summary | |
void |
addChild(dkDataObject parent,
dkDataObject child)
Add a new child member to the parent in the datastore |
void |
addLink(DKLink link)
Add a new link between a source and target item to the datastore. |
void |
addPart(dkDataObject parent,
dkXDO part)
Add a new part member to the parent in the datastore |
void |
addToFolder(dkDataObject folder,
dkDataObject member)
Add a new element item to this folder in memory. |
void |
changePassword(java.lang.String userId,
java.lang.String oldPwd,
java.lang.String newPwd)
Changing password on the the server for the given userid |
java.lang.String |
checkedOutUserid(dkDataObject item)
Gets the userId that checkout the item from the datastore. |
void |
checkIn(dkDataObject item)
Checks-in a document or folder item previously checked out from the datastore. |
void |
checkOut(dkDataObject item)
Checks-out a document or folder item from the datastore. |
DKCommonPrivilege |
getCommonItemPrivilege(dkDataObject item)
Gets the commmon privilege for an item. |
DKCommonPrivilege |
getCommonPrivilege()
Gets the commmon privilege of a specific datastore. |
DKCommonPrivilege |
getCommonPrivilege(dkDataObject item)
Deprecated. Replace by getCommonItemPrivilege |
dkDatastore |
getDatastore()
Gets the reference to the owner datastore object. |
DKSequentialCollection |
getFoldersContainingDDO(dkDataObject ddo)
Get a list of the folders that contain this ddo. |
boolean |
isCheckedOut(dkDataObject item)
Checks if a document or folder item was checked out from the datastore. |
boolean |
isSupported(java.lang.String functionName)
Query if the given function name is supported by this extension. |
java.lang.String[] |
listFunctions()
Lists all supported function-names from this extension. |
void |
moveObject(dkDataObject srcDataObj,
dkDataObject destDataObj,
int options)
Moves current dataobject from one entity to another. |
void |
moveObject(dkDataObject dataObj,
java.lang.String entityName)
Deprecated. Replace by moveObject |
void |
removeChild(dkDataObject parent,
dkDataObject child)
Removes a child member from the parent in the datastore |
void |
removeFromFolder(dkDataObject folder,
dkDataObject member)
Removes an element from this folder in memory. |
void |
removeLink(DKLink link)
Removes a link between a source and target item from the datastore. |
void |
removeLinks(dkCollection linkCollection)
Removes a collection of links from the datastore. |
void |
removePart(dkDataObject parent,
dkXDO part)
Removes a part member from the parent in the datastore |
dkXDO |
retrieveFormOverlay(java.lang.String id)
Retrieves the form overlay object |
void |
setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object. |
void |
unlockCheckedOut(dkDataObject item)
Unlocks the item from the datastore |
Methods inherited from interface com.ibm.mm.sdk.common.dkExtension |
getName, setName |
Method Detail |
public dkDatastore getDatastore() throws java.lang.Exception
public void setDatastore(dkDatastore ds) throws DKUsageError, java.lang.Exception
ds
- datastore.public boolean isSupported(java.lang.String functionName) throws java.lang.Exception
functionName
- the name of the function providing this featurespublic java.lang.String[] listFunctions() throws java.lang.Exception
public void addToFolder(dkDataObject folder, dkDataObject member) throws DKException, java.lang.Exception
folder
- a folder object.member
- the member to be added to the folder.
Note:DKUsageError exception thrown if method is not implemented
folder
- a folder object.member
- the member to be added to the folder.public void removeFromFolder(dkDataObject folder, dkDataObject member) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
folder
- a folder objectelement
- the member to be removed from the folderpublic DKSequentialCollection getFoldersContainingDDO(dkDataObject ddo) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
ddo
- DDO to check which folders contain it.public void checkOut(dkDataObject item) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
item
- the item to checked-out.public void checkIn(dkDataObject item) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
item
- the item to checked ipublic DKCommonPrivilege getCommonPrivilege() throws java.lang.Exception, DKException, DKUsageError, DKDatastoreAccessError
Note:DKUsageError exception thrown if method is not implemented
public DKCommonPrivilege getCommonPrivilege(dkDataObject item) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
item
- an itemgetCommonItemPrivilege(com.ibm.mm.sdk.common.dkDataObject)
public DKCommonPrivilege getCommonItemPrivilege(dkDataObject item) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
item
- an itempublic boolean isCheckedOut(dkDataObject item) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
item
- a document or folder itempublic java.lang.String checkedOutUserid(dkDataObject item) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
item
- a document or folder itempublic void unlockCheckedOut(dkDataObject item) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
item
- a document or folder itempublic void changePassword(java.lang.String userId, java.lang.String oldPwd, java.lang.String newPwd) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
userId
- userid to change password foroldPwd
- current passwordnewPwd
- new passwordpublic void moveObject(dkDataObject dataObj, java.lang.String entityName) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
item
- a document or folder to be reindexedentityName
- index class name to move to.moveObject(com.ibm.mm.sdk.common.dkDataObject,com.ibm.mm.sdk.common.dkDataObject,int)
public void moveObject(dkDataObject srcDataObj, dkDataObject destDataObj, int options) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
item
- source item to be moved to another entityitem
- destination item to be moved intooptions
- move options.public dkXDO retrieveFormOverlay(java.lang.String id) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
id
- the id string to retrieve the objectpublic void addChild(dkDataObject parent, dkDataObject child) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
parent
- a parent object.child
- the child to be added to the parent.public void removeChild(dkDataObject parent, dkDataObject child) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
parent
- a parent object.child
- the child to be added to the parent.public void addLink(DKLink link) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
link
- link objectpublic void removeLink(DKLink link) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
link
- link objectpublic void removeLinks(dkCollection linkCollection) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
linkCollection
- link collection that contain linkspublic void addPart(dkDataObject parent, dkXDO part) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
parent
- a parent object.part
- the part to be added to the parent.public void removePart(dkDataObject parent, dkXDO part) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
parent
- a parent object.part
- the part to be removed from the parent.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |