Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkDatastoreIntICM

All Superinterfaces:
dkDatastore, dkQueryEvaluator, dkQueryManager
All Known Implementing Classes:
DKDatastoreICM

public interface dkDatastoreIntICM
extends dkDatastore

dkDatastoreIntICM: the following methods are additions or modifications of the existing method in the current implementation of dkDatastoreIntICM


Method Summary
 boolean adminDomainEnabled()
          Return true if admin domain is enabled for this 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.
 DKDDO createChildDDO(java.lang.String objectType, java.lang.String componentName)
          Create a child DDO.
 DKDDO createDDO(DKPidICM pid)
          Create a DDO with the given DKPidICM object
 DKDDO createDDO(java.lang.String pidString)
          Create a DDO with the given pid string.
 boolean informationMiningEnabled()
          Return true if information mining is enabled for this datastore.
 boolean LDAPEnabled()
          Return true if LDAP is enabled for this datastore.
 void moveObject(dkDataObject srcDDO, dkDataObject destDDO, int options)
           
 void moveObject(dkDataObject ddo, java.lang.String entityName)
           
 short platform()
          Return the platform of that the server for this datastore is running on.
 java.lang.String schemaName()
          Returns the schema Name
 void startTransaction()
          Starts a transaction
 boolean textSearchEnabled()
          Return true if text search is enabled for this datastore.
 boolean workflowEnabled()
          Return true if workflow is enabled for this datastore.
 
Methods inherited from interface com.ibm.mm.sdk.common.dkDatastore
addExtension, addObject, addObject, addObject, addObjects, addObjects, addObjects, changePassword, clearCache, clearCache, commit, connect, connection, createDDO, createQuery, createQuery, datastoreDef, datastoreName, datastoreType, deleteObject, deleteObject, deleteObject, deleteObjects, deleteObjects, deleteObjects, destroy, disconnect, evaluate, evaluate, evaluate, evaluate, execute, execute, execute, execute, executeWithCallback, executeWithCallback, executeWithCallback, executeWithCallback, getExtension, getMapping, getOption, handle, isConnected, listAvailableServices, listDataSourceNames, listDataSources, listEntities, listEntityAttrNames, listEntityAttrs, listEntityNames, listExtensionNames, listMappingNames, listSchema, listSchemaAttributes, listSearchableEntities, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, listServers, registerMapping, removeExtension, retrieveObject, retrieveObject, retrieveObject, retrieveObjects, retrieveObjects, retrieveObjects, rollback, serviceMgr, setOption, unRegisterMapping, updateObject, updateObject, updateObject, updateObjects, updateObjects, updateObjects, userName
 

Method Detail

startTransaction

public void startTransaction()
                      throws DKException,
                             java.lang.Exception
Starts a transaction
Specified by:
startTransaction in interface dkDatastore

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.
Parameters:
item - the item to checked-in

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.
Parameters:
item - the item to checked-out.

createDDO

public DKDDO createDDO(java.lang.String pidString)
                throws DKException,
                       java.lang.Exception
Create a DDO with the given pid string.
Parameters:
pidString - A pidstring obtained from the DKPidICM pidString method.

createDDO

public DKDDO createDDO(DKPidICM pid)
                throws DKException,
                       java.lang.Exception
Create a DDO with the given DKPidICM object
Parameters:
pid - An object that is an instance of DKPidICM

createChildDDO

public DKDDO createChildDDO(java.lang.String objectType,
                            java.lang.String componentName)
                     throws DKException,
                            java.lang.Exception
Create a child DDO. Creates a child component specified by the component name, under the defined object type (root DDO Item Type).
Parameters:
objectType - The object type that this child is defined under (Root Item Type it is defined under).
componentName - The child / component name to create.

schemaName

public java.lang.String schemaName()
                            throws DKException,
                                   java.lang.Exception
Returns the schema Name
Returns:
schema name

informationMiningEnabled

public boolean informationMiningEnabled()
                                 throws java.lang.Exception
Return true if information mining is enabled for this datastore.
Returns:
true if information mining is enabled.

LDAPEnabled

public boolean LDAPEnabled()
                    throws java.lang.Exception
Return true if LDAP is enabled for this datastore.
Returns:
true if LDAP is enabled.

adminDomainEnabled

public boolean adminDomainEnabled()
                           throws java.lang.Exception
Return true if admin domain is enabled for this datastore.
Returns:
true if admin domain is enabled.

platform

public short platform()
               throws java.lang.Exception
Return the platform of that the server for this datastore is running on. Possible values for this are:
Returns:
Short specifying the platform of the server.

textSearchEnabled

public boolean textSearchEnabled()
                          throws java.lang.Exception
Return true if text search is enabled for this datastore.
Returns:
true if text search is enabled.

workflowEnabled

public boolean workflowEnabled()
                        throws java.lang.Exception
Return true if workflow is enabled for this datastore.
Returns:
true if workflow is enabled.

moveObject

public void moveObject(dkDataObject ddo,
                       java.lang.String entityName)
                throws DKException,
                       java.lang.Exception

moveObject

public void moveObject(dkDataObject srcDDO,
                       dkDataObject destDDO,
                       int options)
                throws DKException,
                       java.lang.Exception

EIP Java APIs

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