Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatastoreDefDL

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

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

This class defines methods to access datastore def information in DL.

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
DKDatastoreDefDL(dkDatastore ds)
          Constructs a DKDatastoreDefDL
 
Method Summary
 void add(dkEntityDef entityObj)
          Adds the given entity object to persitent datastore
 void addAttr(dkAttrDef attrObj)
          Adds the given attribute object to persitent datastore
 dkAttrDef createAttr()
          Creates new dkAttrDef and returns it to caller.
 dkEntityDef createEntity()
          Creates a new dkEntityDef 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
 void delAttr(dkAttrDef attrObj)
          Deletes the given attribute object from persistent datastore
 dkEntityDef getEntity(java.lang.String entityName)
          Gets the dkEntityDef object for the given entity name from persistent datastore.
 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
 dkCollection listEntities()
          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
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreDef
clearCache, datastoreName, datastoreType, deleteEntity, getDatastore, listEntities, listEntities, 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

DKDatastoreDefDL

public DKDatastoreDefDL(dkDatastore ds)
Constructs a DKDatastoreDefDL
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

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

listEntities

public dkCollection listEntities()
                          throws DKException,
                                 java.lang.Exception
Gets a list of entities from persistent datastore
Overrides:
listEntities in class dkAbstractDatastoreDef
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
Overrides:
listEntityNames in class dkAbstractDatastoreDef
Returns:
an array of entity names
Throws:
DKException - if error occurs

listEntityAttrs

public dkCollection listEntityAttrs(java.lang.String entityName)
                             throws DKException,
                                    java.lang.Exception
Gets a list of attributes for a given entity name.
Overrides:
listEntityAttrs in class dkAbstractDatastoreDef
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.
Overrides:
listEntityAttrNames in class dkAbstractDatastoreDef
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

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

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
Returns:
a dkDatastoreAdmin object

createAttr

public dkAttrDef createAttr()
                     throws DKException,
                            java.lang.Exception
Creates new dkAttrDef and returns it to caller.
Returns:
new dkAttrDef object.

addAttr

public void addAttr(dkAttrDef attrObj)
             throws DKException,
                    java.lang.Exception
Adds the given attribute object to persitent datastore
Parameters:
attrObj - attribute object to be added.
Throws:
DKException - if the attribute object is invalid or error occurs in the server.

delAttr

public void delAttr(dkAttrDef attrObj)
             throws DKException,
                    java.lang.Exception
Deletes the given attribute object from persistent datastore
Parameters:
attrObj - the entity object to be deleted.
Throws:
DKException - if the attrObj is invalid or does not exist in the server.

EIP Java APIs

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