Enterprise Information Portal APIs

com.ibm.mm.sdk.server
Class DKDatastoreExtIP

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

public class DKDatastoreExtIP
extends dkAbstractDatastoreExt
implements DKConstantIP, DKMessageIdIP

DKDatastoreExtIP is the implementation class of IP datastore extension object.


Fields inherited from interface com.ibm.mm.sdk.common.DKConstantIP
    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.DKMessageIdIP
copyright, DK_IP_MSG_API_PROTOCOL_ERROR, DK_IP_MSG_CLIENT_API_NOT_OK, DK_IP_MSG_DATASTORE_READONLY, DK_IP_MSG_DOCIDNOTSET, DK_IP_MSG_FAF_ERROR, DK_IP_MSG_FAF_INTERNAL_ERROR, DK_IP_MSG_FAF_NOT_OK, DK_IP_MSG_FAF_WARNING, DK_IP_MSG_FOLDER_NOT_EMPTY, DK_IP_MSG_HOST_TIMEOUT, DK_IP_MSG_INVALID_CONN_OPTION, DK_IP_MSG_INVALID_DOCTYPE, DK_IP_MSG_INVALID_IODM_RC, DK_IP_MSG_INVALID_PARM, DK_IP_MSG_IODM_FAILURE, DK_IP_MSG_IODM_NOT_AVAILABLE, DK_IP_MSG_LOCKEDBYANOTHER, DK_IP_MSG_MISSING_CONN_OPTION, DK_IP_MSG_MSGID_NOT_FOUND, DK_IP_MSG_PROTOCOL_ERROR
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKDatastoreExtIP()
          Default constructor for DKDatastoreExtIP.
DKDatastoreExtIP(dkDatastore ds)
          Constructs a DKDatastoreExtIP for a given datastore object.
 
Method Summary
 void addPart(dkDataObject parent, dkXDO part)
          Add a new part member to the parent in the datastore
 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 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 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, addToFolder, changePassword, getCommonItemPrivilege, getCommonPrivilege, getFoldersContainingDDO, moveObject, moveObject, removeChild, removeFromFolder, removeLink, removeLinks
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDatastoreExtIP

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

DKDatastoreExtIP

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

getDatastore

public dkDatastore getDatastore()
                         throws java.lang.Exception
Gets the reference to the owning 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 owning 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. Returns null if there are no functions supported.
Overrides:
listFunctions in class dkAbstractDatastoreExt
Returns:
an array of supported function names, or null if there is no function supported

checkOut

public void checkOut(dkDataObject item)
              throws DKException,
                     java.lang.Exception
Checks-out a document or folder item from the datastore. The current user will have exclusive updating privileges to the item. All other users are allowed read access only, until the object is checked back in. Note: For IP/390, the following rules apply:

checkIn

public void checkIn(dkDataObject item)
             throws DKException,
                    java.lang.Exception
Checks-in a document or folder item previously checked out from the datastore. Check-in releases all updating privileges to this item. Note: For IP/390, the following rules apply:

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

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.