|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.server.dkAbstractDatastoreExt | +--com.ibm.mm.sdk.server.DKDatastoreExtDL
DKDatastoreExtDL is the implementation class of DL datastore extension object.
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDL |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant |
For details, see the class or interface |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdDL |
DK_DL_MSG_INVNBR_TEXTMAPPING, DK_DL_MSG_MSGID_NOT_FOUND |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKDatastoreExtDL()
Default constructor for DKDatastoreExtDL. |
|
DKDatastoreExtDL(dkDatastore ds)
Constructs a DKDatastoreExtDL for a given datastore object. |
Method Summary | |
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 member item to this folder and reflects the results immediately in the datastore, that is, make it persistent. |
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 |
getCommonPrivilege()
Gets the commmon privilege of a specific datastore. |
dkDatastore |
getDatastore()
Gets the reference to the owner datastore object. |
java.lang.String |
getName()
Gets the name of this extension object. |
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 item,
java.lang.String indexClassName)
Moves the current data object from current entity to another. |
void |
removeFromFolder(dkDataObject folder,
dkDataObject member)
Removes a member from this folder and reflects the results immediately in the datastore, that is, make it persistent. |
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 |
setName(java.lang.String extName)
Sets the name of this extension object. |
void |
unlockCheckedOut(dkDataObject item)
Unlocks the item from the datastore |
Methods inherited from class com.ibm.mm.sdk.server.dkAbstractDatastoreExt |
addChild, addLink, getCommonItemPrivilege, getCommonPrivilege, getFoldersContainingDDO, moveObject, removeChild, removeLink, removeLinks |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKDatastoreExtDL() throws DKException, java.lang.Exception
public DKDatastoreExtDL(dkDatastore ds) throws DKException, java.lang.Exception
Method Detail |
public dkDatastore getDatastore() throws java.lang.Exception
getDatastore
in class dkAbstractDatastoreExt
public void setDatastore(dkDatastore ds) throws DKUsageError, java.lang.Exception
setDatastore
in class dkAbstractDatastoreExt
ds
- datastore.public java.lang.String getName() throws java.lang.Exception
getName
in class dkAbstractDatastoreExt
public void setName(java.lang.String extName) throws java.lang.Exception
setName
in class dkAbstractDatastoreExt
extName
- name of this extension object.public boolean isSupported(java.lang.String functionName) throws java.lang.Exception
isSupported
in class dkAbstractDatastoreExt
functionName
- the name of the function providing this featurespublic java.lang.String[] listFunctions() throws java.lang.Exception
listFunctions
in class dkAbstractDatastoreExt
public void addToFolder(dkDataObject folder, dkDataObject member) throws DKException, java.lang.Exception
addToFolder
in class dkAbstractDatastoreExt
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
removeFromFolder
in class dkAbstractDatastoreExt
folder
- a folder objectmember
- the member to be removed from the folderpublic void checkOut(dkDataObject item) throws DKException, java.lang.Exception
checkOut
in class dkAbstractDatastoreExt
item
- the item to checked-out.public void checkIn(dkDataObject item) throws DKException, java.lang.Exception
checkIn
in class dkAbstractDatastoreExt
item
- the item to checked-inpublic DKCommonPrivilege getCommonPrivilege() throws java.lang.Exception, DKException, DKUsageError, DKDatastoreAccessError
getCommonPrivilege
in class dkAbstractDatastoreExt
public boolean isCheckedOut(dkDataObject item) throws DKException, java.lang.Exception
isCheckedOut
in class dkAbstractDatastoreExt
item
- a document or folder itempublic java.lang.String checkedOutUserid(dkDataObject item) throws DKException, java.lang.Exception
checkedOutUserid
in class dkAbstractDatastoreExt
item
- a document or folder itempublic void unlockCheckedOut(dkDataObject item) throws DKException, java.lang.Exception
unlockCheckedOut
in class dkAbstractDatastoreExt
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
dkAbstractDatastoreExt
Note:DKUsageError exception thrown if method is not implemented
changePassword
in class dkAbstractDatastoreExt
com.ibm.mm.sdk.server.dkAbstractDatastoreExt
userId
- userid to change password foroldPwd
- current passwordnewPwd
- new passwordpublic void moveObject(dkDataObject item, java.lang.String indexClassName) throws DKException, java.lang.Exception
moveObject
in class dkAbstractDatastoreExt
dataObj
- data object to be movedentityName
- new entity name to move topublic dkXDO retrieveFormOverlay(java.lang.String id) throws DKException, java.lang.Exception
retrieveFormOverlay
in class dkAbstractDatastoreExt
id
- the id string to retrieve the objectpublic void addPart(dkDataObject parent, dkXDO part) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
addPart
in class dkAbstractDatastoreExt
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
removePart
in class dkAbstractDatastoreExt
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 |