|
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.DKDatastoreExtICM
DKDatastoreExtICM is the implementation class of ICM 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.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
DKDatastoreExtICM()
Default constructor for DKDatastoreExtICM. |
|
DKDatastoreExtICM(DKDatastoreICM ds)
Constructs a DKDatastoreExtICM for a given datastore object. |
Method Summary | |
void |
addLink(DKLink link)
Add a new link between a source and target item. |
void |
addToFolder(dkDataObject holder,
dkDataObject object)
Add an object to an ICM Document Model Folder. |
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)
Get the UserId that checked out / locked the specified Item. |
void |
checkIn(dkDataObject item)
Checks in a item. |
void |
checkOut(dkDataObject item)
Checks out a item. |
DKCommonPrivilege |
getCommonItemPrivilege(dkDataObject item)
Gets the commmon privilege for an item. |
DKCommonPrivilege |
getCommonPrivilege()
Gets the commmon privilege of a specific datastore. |
dkDatastore |
getDatastore()
Gets the reference to the owner datastore object. |
DKSequentialCollection |
getFoldersContainingDDO(dkDataObject ddo)
Get a list of the folders that contain this ddo. |
java.lang.String |
getName()
Gets the name of this extension object. |
boolean |
isCheckedOut(dkDataObject item)
Determine if an Item is checked out or locked by any user. |
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 srcItem,
dkDataObject destItem,
int options)
Moves an item from the current item type to another. |
void |
moveObject(dkDataObject item,
java.lang.String destinationItemType)
Moves an item from the current item type to another. |
void |
removeFromFolder(dkDataObject holder,
dkDataObject object)
Remove the specified object from the ICM Document Model Folder. |
void |
removeLink(DKLink link)
Removes a link between a source and target item. |
void |
removeLinks(dkCollection links)
Breaks all links specified in the DKLinkCollection. |
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. |
Methods inherited from class com.ibm.mm.sdk.server.dkAbstractDatastoreExt |
addChild, addPart, getCommonPrivilege, removeChild, removePart, retrieveFormOverlay, unlockCheckedOut |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKDatastoreExtICM() throws DKException, java.lang.Exception
public DKDatastoreExtICM(DKDatastoreICM 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 DKCommonPrivilege getCommonPrivilege() throws java.lang.Exception, DKException, DKUsageError, DKDatastoreAccessError
getCommonPrivilege
in class dkAbstractDatastoreExt
public DKCommonPrivilege getCommonItemPrivilege(dkDataObject item) throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
getCommonItemPrivilege
in class dkAbstractDatastoreExt
item
- an itempublic void addLink(DKLink link) throws DKException, java.lang.Exception, DKUsageError
addLink
in class dkAbstractDatastoreExt
link
- link objectpublic void removeLink(DKLink link) throws DKException, java.lang.Exception, DKUsageError
removeLink
in class dkAbstractDatastoreExt
link
- link objectpublic void addToFolder(dkDataObject holder, dkDataObject object) throws DKException, java.lang.Exception, DKUsageError
addToFolder
in class dkAbstractDatastoreExt
holder
- The ICM Folder that is to hold the object.object
- The object that is to be held by the ICM Folder.public void removeFromFolder(dkDataObject holder, dkDataObject object) throws DKException, java.lang.Exception, DKUsageError
removeFromFolder
in class dkAbstractDatastoreExt
holder
- The folder that holds the object.objectToRemove
- The object that is held by the folder.public DKSequentialCollection getFoldersContainingDDO(dkDataObject ddo) throws DKUsageError, java.lang.Exception
getFoldersContainingDDO
in class dkAbstractDatastoreExt
ddo
- DDO to check which folders contain it.public void removeLinks(dkCollection links) throws DKException, java.lang.Exception, DKUsageError
removeLinks
in class dkAbstractDatastoreExt
links
- DKLinkColleciton containing the links to be broken.public boolean isCheckedOut(dkDataObject item) throws DKException, java.lang.Exception
isCheckedOut
in class dkAbstractDatastoreExt
item
- Item to check if it is checked out or not.public java.lang.String checkedOutUserid(dkDataObject item) throws DKException, java.lang.Exception
checkedOutUserid
in class dkAbstractDatastoreExt
item
- Item that was checked out or locked.public void checkIn(dkDataObject item) throws DKException, java.lang.Exception
checkIn
in class dkAbstractDatastoreExt
item
- The item to be checked in.public void checkOut(dkDataObject item) throws DKException, java.lang.Exception
checkOut
in class dkAbstractDatastoreExt
item
- The item to be checked out.public void moveObject(dkDataObject item, java.lang.String destinationItemType) throws DKException, java.lang.Exception
moveObject
in class dkAbstractDatastoreExt
item
- the item to be moveddestinationItemType
- the destination item type to move tocom.ibm.mm.sdk.DKDatastoreICM#moveObject(com.ibm.mm.sdk.common.dkDataObject, java.lang,String)
public void moveObject(dkDataObject srcItem, dkDataObject destItem, int options) throws DKException, java.lang.Exception
moveObject
in class dkAbstractDatastoreExt
srcItem
- the item to be moveddestItem
- the destination item contains extra attributes
belong to destination item typeoptions
- the optionsDKDatastoreICM.moveObject(com.ibm.mm.sdk.common.dkDataObject,
com.ibm.mm.sdk.common.dkDataObject, int)
public 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 password
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |