Enterprise Information Portal APIs

com.ibm.mm.sdk.server
Class DKDatastoreExtDL

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

public class DKDatastoreExtDL
extends dkAbstractDatastoreExt
implements DKConstantDL, DKMessageIdDL

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

DKDatastoreExtDL

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

DKDatastoreExtDL

public DKDatastoreExtDL(dkDatastore ds)
                 throws DKException,
                        java.lang.Exception
Constructs a DKDatastoreExtDL 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

addToFolder

public void addToFolder(dkDataObject folder,
                        dkDataObject member)
                 throws DKException,
                        java.lang.Exception
Add a new member item to this folder and reflects the results immediately in the datastore, that is, make it persistent. In Digital Library, the member must exists (has been created) in the datastore before it can be added to a folder.
Overrides:
addToFolder in class dkAbstractDatastoreExt
Parameters:
folder - a folder object.
member - the member to be added to the folder.

removeFromFolder

public void removeFromFolder(dkDataObject folder,
                             dkDataObject member)
                      throws DKException,
                             java.lang.Exception
Removes a member from this folder and reflects the results immediately in the datastore, that is, make it persistent. At the end of the operation, the member object will not be in this DKFolder collection in-memory, and it will also be removed from the persistent folder representation in the datastore.
Overrides:
removeFromFolder in class dkAbstractDatastoreExt
Parameters:
folder - a folder object
member - the member to be removed from the folder

checkOut

public void checkOut(dkDataObject item)
              throws DKException,
                     java.lang.Exception
Checks-out a document or folder item from the datastore. You will have exclusive updating privileges to the item, while other users are allowed read access only, until you check it back in.
Overrides:
checkOut in class dkAbstractDatastoreExt
Parameters:
item - the item to checked-out.

checkIn

public void checkIn(dkDataObject item)
             throws DKException,
                    java.lang.Exception
Checks-in a document or folder item previously checked out from the datastore. You release all write privileges to this item with this method.
Overrides:
checkIn in class dkAbstractDatastoreExt
Parameters:
item - the item to checked-in

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

isCheckedOut

public boolean isCheckedOut(dkDataObject item)
                     throws DKException,
                            java.lang.Exception
Checks if a document or folder item was checked out from the datastore.
Overrides:
isCheckedOut in class dkAbstractDatastoreExt
Parameters:
item - a document or folder item
Returns:
true if item was checked-out, otherwise return false

checkedOutUserid

public java.lang.String checkedOutUserid(dkDataObject item)
                                  throws DKException,
                                         java.lang.Exception
Gets the userId that checkout the item from the datastore.
Overrides:
checkedOutUserid in class dkAbstractDatastoreExt
Parameters:
item - a document or folder item
Returns:
the userid that checked out the item

unlockCheckedOut

public void unlockCheckedOut(dkDataObject item)
                      throws DKException,
                             java.lang.Exception
Unlocks the item from the datastore
Overrides:
unlockCheckedOut in class dkAbstractDatastoreExt
Parameters:
item - a document or folder item

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

moveObject

public void moveObject(dkDataObject item,
                       java.lang.String indexClassName)
                throws DKException,
                       java.lang.Exception
Moves the current data object from current entity to another.
Overrides:
moveObject in class dkAbstractDatastoreExt
Parameters:
dataObj - data object to be moved
entityName - new entity name to move to

retrieveFormOverlay

public dkXDO retrieveFormOverlay(java.lang.String id)
                          throws DKException,
                                 java.lang.Exception
Retrieves the form overlay object
Overrides:
retrieveFormOverlay in class dkAbstractDatastoreExt
Parameters:
id - the id string to retrieve the object
Returns:
the form overlay xdo object

addPart

public void addPart(dkDataObject parent,
                    dkXDO part)
             throws DKException,
                    java.lang.Exception
Add a new part member to the parent in the datastore

Note:DKUsageError exception thrown if method is not implemented

Overrides:
addPart in class dkAbstractDatastoreExt
Parameters:
parent - a parent object.
part - the part to be added to the parent.

removePart

public void removePart(dkDataObject parent,
                       dkXDO part)
                throws DKException,
                       java.lang.Exception
Removes a part member from the parent in the datastore

Note:DKUsageError exception thrown if method is not implemented

Overrides:
removePart in class dkAbstractDatastoreExt
Parameters:
parent - a parent object.
part - the part to be removed from the parent.

EIP Java APIs

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