Enterprise Information Portal APIs

com.ibm.mm.sdk.server
Class DKDatastoreExtDES

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

public class DKDatastoreExtDES
extends dkAbstractDatastoreExt
implements DKConstantDES, DKMessageIdDES

DKDatastoreExtDES is the implementation class of DES datastore extension object.


Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDES
DK_DES_APPID_HANDLE, DK_DES_APPINFO_HANDLE, DK_DES_BROKER_HANDLE, DK_DES_CMBROOT, DK_DES_DATASOURCE, DK_DES_DLL_NAME, DK_DES_DSTYPE, DK_DES_GQL_QL_TYPE, DK_DES_INIFILE, DK_DES_ITEMID_SEPARATOR, DK_DES_PORT, DK_DES_PROPERTY_DISPNAME, DK_DES_PROPERTY_HELPTEXT, DK_DES_PROPERTY_LANGUAGE, DK_DES_PROPERTY_RETRIEVABLE, DK_DES_PROPERTY_SEARCHABLE, DK_DES_PROPERTY_SEARCHOPERATOR, DK_DES_PROPERTY_VALUECOUNT, DK_DES_REPOSITORIES_HANDLE, DK_DES_RMIREF_HANDLE, DK_DES_SESSION_HANDLE, DK_FILESYSTEM_ENTITY, DK_NOTES_ENTITY, DK_NOTESPUMP_ENTITY, DK_WEB_ENTITY
 
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.DKMessageIdDES
DK_DES_MSG_MSGID_NOT_FOUND
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKDatastoreExtDES()
          Default constructor for DKDatastoreExtDES.
DKDatastoreExtDES(dkDatastore ds)
          Constructs a DKDatastoreExtDES for a given datastore object.
 
Method Summary
 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 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 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, addToFolder, changePassword, checkedOutUserid, checkIn, checkOut, getCommonItemPrivilege, getCommonPrivilege, getFoldersContainingDDO, isCheckedOut, moveObject, moveObject, removeChild, removeFromFolder, removeLink, removeLinks, removePart, retrieveFormOverlay, unlockCheckedOut
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDatastoreExtDES

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

DKDatastoreExtDES

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

EIP Java APIs

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