Enterprise Information Portal APIs

com.ibm.mm.sdk.server
Class DKDatastoreExtICM

java.lang.Object
  |
  +--com.ibm.mm.sdk.server.dkAbstractDatastoreExt
        |
        +--com.ibm.mm.sdk.server.DKDatastoreExtICM
All Implemented Interfaces:
DKConstant, dkDatastoreExt, dkExtension, DKMessageId

public class DKDatastoreExtICM
extends dkAbstractDatastoreExt

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

DKDatastoreExtICM

public DKDatastoreExtICM()
                  throws DKException,
                         java.lang.Exception
Default constructor for DKDatastoreExtICM.

DKDatastoreExtICM

public DKDatastoreExtICM(DKDatastoreICM ds)
                  throws DKException,
                         java.lang.Exception
Constructs a DKDatastoreExtICM for a given datastore object.
Method Detail

getDatastore

public dkDatastore getDatastore()
                         throws java.lang.Exception
Gets the reference to the owner datastore object.
Overrides:
getDatastore in class dkAbstractDatastoreExt
Returns:
the dkDatastore object.

setDatastore

public void setDatastore(dkDatastore ds)
                  throws DKUsageError,
                         java.lang.Exception
Sets the reference to the owner datastore object.
Overrides:
setDatastore in class dkAbstractDatastoreExt
Parameters:
ds - datastore.

getName

public java.lang.String getName()
                         throws java.lang.Exception
Gets the name of this extension object.
Overrides:
getName in class dkAbstractDatastoreExt
Returns:
name of this object.

setName

public void setName(java.lang.String extName)
             throws java.lang.Exception
Sets the name of this extension object. This operation is not supported, since you can not change the datastore standard extension name.
Overrides:
setName in class dkAbstractDatastoreExt
Parameters:
extName - name of this extension object.

isSupported

public boolean isSupported(java.lang.String functionName)
                    throws java.lang.Exception
Query if the given function name is supported by this extension.
Overrides:
isSupported in class dkAbstractDatastoreExt
Parameters:
functionName - the name of the function providing this features
Returns:
true if this function is supported

listFunctions

public java.lang.String[] listFunctions()
                                 throws java.lang.Exception
Lists all supported function-names from this extension.
Overrides:
listFunctions in class dkAbstractDatastoreExt
Returns:
an array of supported function names, or null if there is no function supported

getCommonPrivilege

public DKCommonPrivilege getCommonPrivilege()
                                     throws java.lang.Exception,
                                            DKException,
                                            DKUsageError,
                                            DKDatastoreAccessError
Gets the commmon privilege of a specific datastore.
Overrides:
getCommonPrivilege in class dkAbstractDatastoreExt
Returns:
a DKCommonPrivilege object

getCommonItemPrivilege

public DKCommonPrivilege getCommonItemPrivilege(dkDataObject item)
                                         throws DKException,
                                                java.lang.Exception
Gets the commmon privilege for an item.

Note:DKUsageError exception thrown if method is not implemented

Overrides:
getCommonItemPrivilege in class dkAbstractDatastoreExt
Parameters:
item - an item
Returns:
a DKCommonPrivilege object

addLink

public void addLink(DKLink link)
             throws DKException,
                    java.lang.Exception,
                    DKUsageError
Add a new link between a source and target item. Additional link information is optional in DKLink object
Overrides:
addLink in class dkAbstractDatastoreExt
Parameters:
link - link object

removeLink

public void removeLink(DKLink link)
                throws DKException,
                       java.lang.Exception,
                       DKUsageError
Removes a link between a source and target item. Additional link information is optional in DKLink object
Overrides:
removeLink in class dkAbstractDatastoreExt
Parameters:
link - link object

addToFolder

public void addToFolder(dkDataObject holder,
                        dkDataObject object)
                 throws DKException,
                        java.lang.Exception,
                        DKUsageError
Add an object to an ICM Document Model Folder. The changes will not take affect in the datastore until DKDDO.add() or DKDDO.update() is called.
Overrides:
addToFolder in class dkAbstractDatastoreExt
Parameters:
holder - The ICM Folder that is to hold the object.
object - The object that is to be held by the ICM Folder.

removeFromFolder

public void removeFromFolder(dkDataObject holder,
                             dkDataObject object)
                      throws DKException,
                             java.lang.Exception,
                             DKUsageError
Remove the specified object from the ICM Document Model Folder. The changes will not take affect in the datastore until DKDDO.add() or DKDDO.update() is called.
Overrides:
removeFromFolder in class dkAbstractDatastoreExt
Parameters:
holder - The folder that holds the object.
objectToRemove - The object that is held by the folder.

getFoldersContainingDDO

public DKSequentialCollection getFoldersContainingDDO(dkDataObject ddo)
                                               throws DKUsageError,
                                                      java.lang.Exception
Get a list of the folders that contain this ddo. List returned as collection of skeleton DDOs with completed Pid information.
Overrides:
getFoldersContainingDDO in class dkAbstractDatastoreExt
Parameters:
ddo - DDO to check which folders contain it.
Returns:
List of Folders that contain this ddo (Skeleton DDOs with Pid information completed.)

removeLinks

public void removeLinks(dkCollection links)
                 throws DKException,
                        java.lang.Exception,
                        DKUsageError
Breaks all links specified in the DKLinkCollection. It does not remove the DKLink objects from the collection. Calling DKLinkCollection.removeAllMembers() will break all links in the link collecion and remove all elements.
Overrides:
removeLinks in class dkAbstractDatastoreExt
Parameters:
links - DKLinkColleciton containing the links to be broken.

isCheckedOut

public boolean isCheckedOut(dkDataObject item)
                     throws DKException,
                            java.lang.Exception
Determine if an Item is checked out or locked by any user.
Overrides:
isCheckedOut in class dkAbstractDatastoreExt
Parameters:
item - Item to check if it is checked out or not.
Returns:
Returns true if it is checked out or locked, false if not.

checkedOutUserid

public java.lang.String checkedOutUserid(dkDataObject item)
                                  throws DKException,
                                         java.lang.Exception
Get the UserId that checked out / locked the specified Item.
Overrides:
checkedOutUserid in class dkAbstractDatastoreExt
Parameters:
item - Item that was checked out or locked.
Returns:
Returns the UserId that checked out or locked the specified Item.

checkIn

public void checkIn(dkDataObject item)
             throws DKException,
                    java.lang.Exception
Checks in a item.
Overrides:
checkIn in class dkAbstractDatastoreExt
Parameters:
item - The item to be checked in.

checkOut

public void checkOut(dkDataObject item)
              throws DKException,
                     java.lang.Exception
Checks out a item.
Overrides:
checkOut in class dkAbstractDatastoreExt
Parameters:
item - The item to be checked out.

moveObject

public void moveObject(dkDataObject item,
                       java.lang.String destinationItemType)
                throws DKException,
                       java.lang.Exception
Moves an item from the current item type to another.
Overrides:
moveObject in class dkAbstractDatastoreExt
Parameters:
item - the item to be moved
destinationItemType - the destination item type to move to
See Also:
com.ibm.mm.sdk.DKDatastoreICM#moveObject(com.ibm.mm.sdk.common.dkDataObject, java.lang,String)

moveObject

public void moveObject(dkDataObject srcItem,
                       dkDataObject destItem,
                       int options)
                throws DKException,
                       java.lang.Exception
Moves an item from the current item type to another.
Overrides:
moveObject in class dkAbstractDatastoreExt
Parameters:
srcItem - the item to be moved
destItem - the destination item contains extra attributes belong to destination item type
options - the options
See Also:
DKDatastoreICM.moveObject(com.ibm.mm.sdk.common.dkDataObject, com.ibm.mm.sdk.common.dkDataObject, int)

changePassword

public void changePassword(java.lang.String userId,
                           java.lang.String oldPwd,
                           java.lang.String newPwd)
                    throws DKException,
                           java.lang.Exception
Description copied from class: dkAbstractDatastoreExt
Changing password on the the server for the given userid

Note:DKUsageError exception thrown if method is not implemented

Overrides:
changePassword in class dkAbstractDatastoreExt
Following copied from class: com.ibm.mm.sdk.server.dkAbstractDatastoreExt
Parameters:
userId - userid to change password for
oldPwd - current password
newPwd - new password

EIP Java APIs

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