Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatastoreDefTS

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractDatastoreDef
        |
        +--com.ibm.mm.sdk.common.DKDatastoreDefTS
All Implemented Interfaces:
DKConstant, DKConstantDL, dkDatastoreDef, DKMessageId, DKMessageIdDL, java.io.Serializable

public class DKDatastoreDefTS
extends dkAbstractDatastoreDef
implements DKConstantDL, DKMessageIdDL, java.io.Serializable

This class defines methods to access datastore information as well as to create, list, and delete its entities
It maintains a collection of dkEntityDefs

See Also:
Serialized Form

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
DKDatastoreDefTS(dkDatastore ds)
          Constructs a DKDatastoreDefTS
 
Method Summary
 void add(dkEntityDef entityObj)
          Adds the given entity object to persitent datastore
 dkEntityDef createEntity()
          Creates a new dkEntityDef and return it.
 DKSearchIndexDefTS createSearchIndex()
          Creates a new DKSearchIndexDefTS and return it.
 dkDatastoreAdmin datastoreAdmin()
          Get a datastore administration object for a datastore
 void del(dkEntityDef entityObj)
          Deletes the given entity object from persistent datastore
 dkEntityDef getEntity(java.lang.String entityName)
          Gets the dkEntityDef object for the given entity name from persistent datastore.
 DKSearchIndexDefTS getSearchIndex(java.lang.String searchIndexName)
          Gets the DKSearchIndexDefTS object for the given search index name from persistent datastore.
 dkCollection listEntities()
          Gets a list of entities from persisten datastore
 java.lang.String[] listEntityNames()
          Gets a list of entity names from persistent datastore
 dkCollection listSearchIndexes()
          Gets a list of search indexes from persisten datastore
 java.lang.String[] listSearchIndexNames()
          Gets a list of search index names from persistent datastore
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreDef
clearCache, datastoreName, datastoreType, deleteEntity, getDatastore, listEntities, listEntities, listEntityAttrNames, listEntityAttrs, listEntityNames, listEntityNames, listSearchableEntities, listSearchableEntities, listSearchableEntities, listSearchableEntityNames, listSearchableEntityNames, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, retrieveEntity, setDatastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDatastoreDefTS

public DKDatastoreDefTS(dkDatastore ds)
Constructs a DKDatastoreDefTS
Parameters:
ds - datastore
Method Detail

createEntity

public dkEntityDef createEntity()
                         throws DKException,
                                java.lang.Exception
Creates a new dkEntityDef and return it.
Overrides:
createEntity in class dkAbstractDatastoreDef
Returns:
a new dkEntityDef

createSearchIndex

public DKSearchIndexDefTS createSearchIndex()
                                     throws DKException,
                                            java.lang.Exception
Creates a new DKSearchIndexDefTS and return it.
Returns:
a new DKSearchIndexDefTS

getEntity

public dkEntityDef getEntity(java.lang.String entityName)
                      throws DKException,
                             java.lang.Exception
Gets the dkEntityDef object for the given entity name from persistent datastore.
Overrides:
getEntity in class dkAbstractDatastoreDef
Parameters:
entityName - name of entity to retrieve
Returns:
dkEntityDef object contains data about the given entityName.
Throws:
DKException - if the entity name is not exist

getSearchIndex

public DKSearchIndexDefTS getSearchIndex(java.lang.String searchIndexName)
                                  throws DKException,
                                         java.lang.Exception
Gets the DKSearchIndexDefTS object for the given search index name from persistent datastore.
Parameters:
searchIndexName - name of search index to retrieve
Returns:
DKSearchIndexDefTS object contains data about the given search index name.
Throws:
DKException - if the search index name is not exist

listEntities

public dkCollection listEntities()
                          throws DKException,
                                 java.lang.Exception
Gets a list of entities from persisten datastore
Overrides:
listEntities in class dkAbstractDatastoreDef
Returns:
a collection of entity defs
Throws:
DKException - if error occurs

listSearchIndexes

public dkCollection listSearchIndexes()
                               throws DKException,
                                      java.lang.Exception
Gets a list of search indexes from persisten datastore
Returns:
a collection of search index defs
Throws:
DKException - if error occurs

listEntityNames

public java.lang.String[] listEntityNames()
                                   throws DKException,
                                          java.lang.Exception
Gets a list of entity names from persistent datastore
Overrides:
listEntityNames in class dkAbstractDatastoreDef
Returns:
an array of entity names
Throws:
DKException - if error occurs

listSearchIndexNames

public java.lang.String[] listSearchIndexNames()
                                        throws DKException,
                                               java.lang.Exception
Gets a list of search index names from persistent datastore
Returns:
an array of entity names
Throws:
DKException - if error occurs

add

public void add(dkEntityDef entityObj)
         throws DKException,
                java.lang.Exception
Adds the given entity object to persitent datastore
Overrides:
add in class dkAbstractDatastoreDef
Parameters:
entityObj - entity object to be added.
Throws:
DKException - if the entity object is invalid or error occurs in the server.

del

public void del(dkEntityDef entityObj)
         throws DKException,
                java.lang.Exception
Deletes the given entity object from persistent datastore
Overrides:
del in class dkAbstractDatastoreDef
Parameters:
entityObj - the entity object to be deleted.
Throws:
DKException - if the entityObj is invalid or does not exist in the server.

datastoreAdmin

public dkDatastoreAdmin datastoreAdmin()
                                throws DKException,
                                       java.lang.Exception
Get a datastore administration object for a datastore
Overrides:
datastoreAdmin in class dkAbstractDatastoreDef
Following copied from class: com.ibm.mm.sdk.common.dkAbstractDatastoreDef
Returns:
dkDatastoreAdmin object reference

EIP Java APIs

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