Enterprise Information Portal APIs

com.ibm.mm.sdk.server
Class DKDatastoreExtFed

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

public class DKDatastoreExtFed
extends dkAbstractDatastoreExt
implements DKConstantDL, DKMessageIdDL

DKDatastoreExtFed is the implementation class of federated 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
DKDatastoreExtFed()
          Default constructor for DKDatastoreExtFed.
DKDatastoreExtFed(dkDatastore ds)
          Constructs a DKDatastoreExtFed for a given datastore object.
 
Method Summary
 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 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.
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object.
 java.lang.String getName()
          Gets the name of this extension object.
 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 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 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, addLink, addPart, changePassword, checkedOutUserid, getCommonItemPrivilege, getCommonPrivilege, getCommonPrivilege, getFoldersContainingDDO, isCheckedOut, moveObject, moveObject, removeChild, removeLink, removeLinks, removePart, retrieveFormOverlay, unlockCheckedOut
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDatastoreExtFed

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

DKDatastoreExtFed

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

EIP Java APIs

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