Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Interface dkDatastoreIntDL

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

public interface dkDatastoreIntDL
extends dkDatastore

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


Method Summary
 void addFolderItem(java.lang.String folderId, java.lang.String memberId)
           
 java.lang.String checkedOutUserid(dkDataObject dobj)
           
 void checkIn(dkDataObject dobj)
           
 void checkOut(dkDataObject dobj)
           
 DKWorkFlowServiceDL createWorkFlowService()
           
 void invokeSearchEngine(java.lang.String searchEngine, java.lang.String searchIndex)
           
 boolean isCheckedOut(dkDataObject dobj)
           
 java.lang.String[] listAttrNames()
          Gets a list of attribute names defined in the current server
 dkCollection listAttrs()
          Gets a list of attributes defined in the current server
 java.lang.String[] listRefFolders(dkDataObject ddo)
          List Reference folders for a given document or folder
 void moveObject(dkDataObject ddo, java.lang.String entityName)
           
 void removeFolderItem(java.lang.String folderId, java.lang.String memberId)
           
 dkXDO retrieveFormOverlay(java.lang.String id)
           
 void startTransaction()
          Starts a transaction
 DKHandle transactionConnection()
           
 void unlockCheckedOut(dkDataObject dobj)
           
 void wakeUpService(java.lang.String serviceName)
           
 
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

moveObject

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

retrieveFormOverlay

public dkXDO retrieveFormOverlay(java.lang.String id)
                          throws DKException,
                                 java.lang.Exception

startTransaction

public void startTransaction()
                      throws DKException,
                             java.lang.Exception
Description copied from interface: dkDatastore
Starts a transaction

Note:DKUsageError exception thrown if method is not implemented

Specified by:
startTransaction in interface dkDatastore

transactionConnection

public DKHandle transactionConnection()
                               throws DKException,
                                      java.lang.Exception

wakeUpService

public void wakeUpService(java.lang.String serviceName)
                   throws DKException,
                          java.lang.Exception

addFolderItem

public void addFolderItem(java.lang.String folderId,
                          java.lang.String memberId)
                   throws DKUsageError,
                          DKDatastoreAccessError,
                          java.lang.Exception

invokeSearchEngine

public void invokeSearchEngine(java.lang.String searchEngine,
                               java.lang.String searchIndex)
                        throws DKException,
                               java.lang.Exception

removeFolderItem

public void removeFolderItem(java.lang.String folderId,
                             java.lang.String memberId)
                      throws DKUsageError,
                             DKDatastoreAccessError,
                             java.lang.Exception

isCheckedOut

public boolean isCheckedOut(dkDataObject dobj)
                     throws DKUsageError,
                            DKDatastoreAccessError,
                            java.lang.Exception

checkedOutUserid

public java.lang.String checkedOutUserid(dkDataObject dobj)
                                  throws DKUsageError,
                                         DKDatastoreAccessError,
                                         java.lang.Exception

unlockCheckedOut

public void unlockCheckedOut(dkDataObject dobj)
                      throws DKUsageError,
                             DKDatastoreAccessError,
                             java.lang.Exception

checkOut

public void checkOut(dkDataObject dobj)
              throws DKUsageError,
                     DKDatastoreAccessError,
                     java.lang.Exception

checkIn

public void checkIn(dkDataObject dobj)
             throws DKUsageError,
                    DKDatastoreAccessError,
                    java.lang.Exception

createWorkFlowService

public DKWorkFlowServiceDL createWorkFlowService()
                                          throws DKException,
                                                 java.lang.Exception

listRefFolders

public java.lang.String[] listRefFolders(dkDataObject ddo)
                                  throws DKException,
                                         java.lang.Exception
List Reference folders for a given document or folder
Parameters:
ddo - the data-object to find folder references for

listAttrs

public dkCollection listAttrs()
                       throws DKException,
                              java.lang.Exception
Gets a list of attributes defined in the current server
Returns:
a dkCollection of dkAttrDef objects
Throws:
DKException - if the entity name does not exist

listAttrNames

public java.lang.String[] listAttrNames()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of attribute names defined in the current server
Returns:
an array of attribute names
Throws:
DKException - if the entity name does not exist

EIP Java APIs

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