Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class dkAbstractDatastoreDef

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractDatastoreDef
All Implemented Interfaces:
dkDatastoreDef, DKMessageId, java.io.Serializable
Direct Known Subclasses:
DKDatastoreDefDB2, DKDatastoreDefDD, DKDatastoreDefDES, DKDatastoreDefDJ, DKDatastoreDefDL, DKDatastoreDefFed, DKDatastoreDefIC, DKDatastoreDefICM, DKDatastoreDefIP, DKDatastoreDefJDBC, DKDatastoreDefOD, DKDatastoreDefQBIC, DKDatastoreDefTS, DKDatastoreDefV4

public abstract class dkAbstractDatastoreDef
extends java.lang.Object
implements dkDatastoreDef, DKMessageId, java.io.Serializable

This class defines methods to access datastore def information

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
dkAbstractDatastoreDef()
          Constructor with default value,
dkAbstractDatastoreDef(dkDatastore ds)
          Constructor with datastore owner reference
 
Method Summary
 void add(dkEntityDef entityObj)
          Adds the given entity object to persitent datastore
 void clearCache()
          Clear datastore def cache
 dkEntityDef createEntity()
          Creates a new dkEntityDef and return it.
 dkDatastoreAdmin datastoreAdmin()
          Gets the reference to dkDatastoreAdmin object
 java.lang.String datastoreName()
          Gets the name of this datastore object.
 java.lang.String datastoreType()
          Gets the type for this datastore object
 void del(dkEntityDef entityObj)
          Deletes the given entity object from persistent datastore
 void deleteEntity(java.lang.String entityName)
          Deletes the dkEntityDef object for the given entity name from persistent datastore.
 dkDatastore getDatastore()
          Gets the reference to the owner datastore object
 dkEntityDef getEntity(java.lang.String entityName)
          Gets the dkEntityDef object for the given entity name (memory-only)
 dkCollection listEntities()
          Gets a list of entities from persistent datastore
 dkCollection listEntities(DKNVPair[] options)
          Gets a list of entities from persistent datastore
 dkCollection listEntities(int options)
          Gets a list of entities from persistent datastore
 java.lang.String[] listEntityAttrNames(java.lang.String entityName)
          Gets a list of attribute names for a given entity name.
 dkCollection listEntityAttrs(java.lang.String entityName)
          Gets a list of attributes for a given entity name.
 java.lang.String[] listEntityNames()
          Gets a list of entity names from persistent datastore
 java.lang.String[] listEntityNames(DKNVPair[] options)
          Gets a list of entity names from persistent datastore
 java.lang.String[] listEntityNames(int options)
          Gets a list of entity names from persistent datastore
 dkCollection listSearchableEntities()
          Gets a list of searchable entities from persistent datastore Usually all entities are searchable, except entities from some datastore types.
 dkCollection listSearchableEntities(DKNVPair[] options)
          Gets a list of searchable entities from persistent datastore Usually all entities are searchable, except entities from some datastore types.
 dkCollection listSearchableEntities(int options)
          Gets a list of searchable entities from persistent datastore Usually all entities are searchable, except entities from some datastore types.
 java.lang.String[] listSearchableEntityNames()
          Gets a list of searchable entity names from persistent datastore
 java.lang.String[] listSearchableEntityNames(DKNVPair[] options)
          Gets a list of searchable entity names from persistent datastore
 java.lang.String[] listSearchableEntityNames(int options)
          Gets a list of searchable entity names from persistent datastore
 java.lang.String[] listSearchTemplateNames()
          Gets a list of search template names from persistent datastore
 dkCollection listSearchTemplates()
          Gets a list of search templates from persistent datastore
 dkEntityDef retrieveEntity(java.lang.String entityName)
          Retrieves the dkEntityDef object for the given entity name from persistent datastore.
 void setDatastore(dkDatastore ds)
          Sets the reference to the owner datastore object
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

dkAbstractDatastoreDef

public dkAbstractDatastoreDef()
Constructor with default value,

dkAbstractDatastoreDef

public dkAbstractDatastoreDef(dkDatastore ds)
Constructor with datastore owner reference
Parameters:
ds - reference to owner datastore
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object
Specified by:
setDatastore in interface dkDatastoreDef

getDatastore

public dkDatastore getDatastore()
Gets the reference to the owner datastore object
Specified by:
getDatastore in interface dkDatastoreDef
Returns:
the dkDatastore object

datastoreName

public java.lang.String datastoreName()
                               throws java.lang.Exception
Gets the name of this datastore object.
Specified by:
datastoreName in interface dkDatastoreDef
Returns:
datastore name

datastoreType

public java.lang.String datastoreType()
                               throws java.lang.Exception
Gets the type for this datastore object
Specified by:
datastoreType in interface dkDatastoreDef
Returns:
datastore type

createEntity

public dkEntityDef createEntity()
                         throws DKException,
                                java.lang.Exception
Creates a new dkEntityDef and return it.

Note:DKUsageError exception thrown if method is not implemented

Specified by:
createEntity in interface dkDatastoreDef
Returns:
a new dkEntityDef

getEntity

public dkEntityDef getEntity(java.lang.String entityName)
                      throws DKException,
                             java.lang.Exception
Gets the dkEntityDef object for the given entity name (memory-only)

Note:DKUsageError exception thrown if method is not implemented

Specified by:
getEntity in interface dkDatastoreDef
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

retrieveEntity

public dkEntityDef retrieveEntity(java.lang.String entityName)
                           throws DKException,
                                  java.lang.Exception
Retrieves the dkEntityDef object for the given entity name from persistent datastore.

Note:DKUsageError exception thrown if method is not implemented

Specified by:
retrieveEntity in interface dkDatastoreDef
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

listEntities

public dkCollection listEntities()
                          throws DKException,
                                 java.lang.Exception
Gets a list of entities from persistent datastore
Specified by:
listEntities in interface dkDatastoreDef
Returns:
a collection of entity defs
Throws:
DKException - if error occurs

listEntities

public dkCollection listEntities(int options)
                          throws DKException,
                                 java.lang.Exception
Gets a list of entities from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listEntities in interface dkDatastoreDef
Parameters:
options - option for listing entities
Returns:
a collection of entity defs
Throws:
DKException - if error occurs

listEntities

public dkCollection listEntities(DKNVPair[] options)
                          throws DKException,
                                 java.lang.Exception
Gets a list of entities from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listEntities in interface dkDatastoreDef
Parameters:
options - option for listing entities
Returns:
a collection of entity defs
Throws:
DKException - if error occurs

listSearchableEntities

public dkCollection listSearchableEntities()
                                    throws DKException,
                                           java.lang.Exception
Gets a list of searchable entities from persistent datastore Usually all entities are searchable, except entities from some datastore types. For example, not all entities of Domino.Doc are searchable.

Note: Default behavior will call dkAbstractDatastoreDef.listEntities()

Specified by:
listSearchableEntities in interface dkDatastoreDef
Returns:
a collection of entity defs
Throws:
DKException - if error occurs

listSearchableEntities

public dkCollection listSearchableEntities(int options)
                                    throws DKException,
                                           java.lang.Exception
Gets a list of searchable entities from persistent datastore Usually all entities are searchable, except entities from some datastore types. For example, not all entities of Domino.Doc are searchable.

Note: Default behavior will call dkAbstractDatastoreDef.listEntities(int)

Specified by:
listSearchableEntities in interface dkDatastoreDef
Parameters:
options - option for listing searchable entities
Returns:
a collection of entity defs
Throws:
DKException - if error occurs

listSearchableEntities

public dkCollection listSearchableEntities(DKNVPair[] options)
                                    throws DKException,
                                           java.lang.Exception
Gets a list of searchable entities from persistent datastore Usually all entities are searchable, except entities from some datastore types. For example, not all entities of Domino.Doc are searchable.

Note: Default behavior will call dkAbstractDatastoreDef.listEntities(DKNVPair[])

Specified by:
listSearchableEntities in interface dkDatastoreDef
Parameters:
options - option for listing searchable entities
Returns:
a collection of entity 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
Specified by:
listEntityNames in interface dkDatastoreDef
Returns:
an array of entity names
Throws:
DKException - if error occurs

listEntityNames

public java.lang.String[] listEntityNames(int options)
                                   throws DKException,
                                          java.lang.Exception
Gets a list of entity names from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listEntityNames in interface dkDatastoreDef
Parameters:
options - option for listing entity names
Returns:
an array of entity names
Throws:
DKException - if error occurs

listEntityNames

public java.lang.String[] listEntityNames(DKNVPair[] options)
                                   throws DKException,
                                          java.lang.Exception
Gets a list of entity names from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listEntityNames in interface dkDatastoreDef
Parameters:
options - option for listing entity names
Returns:
an array of entity names
Throws:
DKException - if error occurs

listSearchableEntityNames

public java.lang.String[] listSearchableEntityNames()
                                             throws DKException,
                                                    java.lang.Exception
Gets a list of searchable entity names from persistent datastore

Note: Default behavior will call dkAbstractDatastoreDef.listEntityNames()

Specified by:
listSearchableEntityNames in interface dkDatastoreDef
Returns:
an array of entity names
Throws:
DKException - if error occurs

listSearchableEntityNames

public java.lang.String[] listSearchableEntityNames(int options)
                                             throws DKException,
                                                    java.lang.Exception
Gets a list of searchable entity names from persistent datastore

Note: Default behavior will call dkAbstractDatastoreDef.listEntityNames(int)

Specified by:
listSearchableEntityNames in interface dkDatastoreDef
Parameters:
options - option for listing searchable entity names
Returns:
an array of entity names
Throws:
DKException - if error occurs
See Also:
listSearchableEntityNames()

listSearchableEntityNames

public java.lang.String[] listSearchableEntityNames(DKNVPair[] options)
                                             throws DKException,
                                                    java.lang.Exception
Gets a list of searchable entity names from persistent datastore
Specified by:
listSearchableEntityNames in interface dkDatastoreDef
Parameters:
options - option for listing searchable entity names

Note: Default behavior will call dkAbstractDatastoreDef.listEntityNames(DKNVPair[])

Returns:
an array of entity names
Throws:
DKException - if error occurs
See Also:
listSearchableEntityNames()

listEntityAttrs

public dkCollection listEntityAttrs(java.lang.String entityName)
                             throws DKException,
                                    java.lang.Exception
Gets a list of attributes for a given entity name.
Specified by:
listEntityAttrs in interface dkDatastoreDef
Parameters:
entityName - name of entity to retrieve attributes for
Returns:
a dkCollection of dkAttrDef objects
Throws:
DKException - if the entity name does not exist

listEntityAttrNames

public java.lang.String[] listEntityAttrNames(java.lang.String entityName)
                                       throws DKException,
                                              java.lang.Exception
Gets a list of attribute names for a given entity name.
Specified by:
listEntityAttrNames in interface dkDatastoreDef
Parameters:
entityName - name of entity to retrieve attribute names for
Returns:
an array of attribute names
Throws:
DKException - if the entity name does not exist

listSearchTemplates

public dkCollection listSearchTemplates()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of search templates from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listSearchTemplates in interface dkDatastoreDef
Returns:
a collection of search templates
Throws:
DKException - if error occurs

listSearchTemplateNames

public java.lang.String[] listSearchTemplateNames()
                                           throws DKException,
                                                  java.lang.Exception
Gets a list of search template names from persistent datastore

Note:DKUsageError exception thrown if method is not implemented

Specified by:
listSearchTemplateNames in interface dkDatastoreDef
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
add in interface dkDatastoreDef
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

Note:DKUsageError exception thrown if method is not implemented

Specified by:
del in interface dkDatastoreDef
Parameters:
entityObj - the entity object to be deleted.
Throws:
DKException - if the entityObj is invalid or does not exist in the server.

deleteEntity

public void deleteEntity(java.lang.String entityName)
                  throws DKException,
                         java.lang.Exception
Deletes the dkEntityDef object for the given entity name from persistent datastore.

Note:DKUsageError exception thrown if method is not implemented

Specified by:
deleteEntity in interface dkDatastoreDef
Parameters:
entityName - name of entity to retrieve
Throws:
DKException - if the entity name is not exist

datastoreAdmin

public dkDatastoreAdmin datastoreAdmin()
                                throws DKException,
                                       java.lang.Exception
Gets the reference to dkDatastoreAdmin object

Note:DKUsageError exception thrown if method is not implemented

Specified by:
datastoreAdmin in interface dkDatastoreDef
Returns:
dkDatastoreAdmin object reference

clearCache

public void clearCache()
                throws DKException,
                       java.lang.Exception
Clear datastore def cache

Note:DKUsageError exception thrown if method is not implemented

Specified by:
clearCache in interface dkDatastoreDef

EIP Java APIs

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