|
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.DKDatastoreExtDD
DKDatastoreExtDD is the implementation class of DD datastore extension object.
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.DKMessageIdDD |
copyright, DK_DD_MSG_MSGID_DOMDOC, DK_DD_MSG_MSGID_GOVERNOR, DK_DD_MSG_MSGID_NO_ATTR_OBJ, DK_DD_MSG_MSGID_NO_BINDER_OBJ, DK_DD_MSG_MSGID_NO_CABINET_OBJ, DK_DD_MSG_MSGID_NO_DOCUMENT_OBJ, DK_DD_MSG_MSGID_NO_MESSAGE, DK_DD_MSG_MSGID_NO_ROOM_OBJ, DK_DD_MSG_MSGID_NO_SUCCESS, DK_DD_MSG_MSGID_NUL_PARAM |
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKDatastoreExtDD()
Default constructor for DKDatastoreExtDD. |
|
DKDatastoreExtDD(dkDatastore ds)
Constructs a DKDatastoreExtDD for a given datastore object. |
Method Summary | |
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 owning 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 |
setDatastore(dkDatastore ds)
Sets the reference to the owning 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, addPart, addToFolder, changePassword, getCommonItemPrivilege, getCommonPrivilege, getFoldersContainingDDO, moveObject, moveObject, removeChild, removeFromFolder, removeLink, removeLinks, removePart, retrieveFormOverlay |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKDatastoreExtDD() throws DKException, java.lang.Exception
public DKDatastoreExtDD(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 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 item
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |