Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatastoreDefOD

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractDatastoreDef
        |
        +--com.ibm.mm.sdk.common.DKDatastoreDefOD
All Implemented Interfaces:
DKConstant, DKConstantOD, dkDatastoreDef, DKMessageId, DKMessageIdOD, java.io.Serializable

public class DKDatastoreDefOD
extends dkAbstractDatastoreDef
implements DKConstantOD, DKMessageIdOD, java.io.Serializable

This class defines methods to access datastore definition information in OnDemand.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantOD
    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.DKMessageIdOD
DK_OD_MSG_INIT_FAILED, DK_OD_MSG_INVALID_API, DK_OD_MSG_INVALID_CHOICE, DK_OD_MSG_INVALID_DATE, DK_OD_MSG_INVALID_DECIMAL, DK_OD_MSG_INVALID_INTEGER, DK_OD_MSG_INVALID_OPERATOR, DK_OD_MSG_INVALID_RANGE, DK_OD_MSG_INVALID_SEARCH, DK_OD_MSG_INVALID_SEGMENT_NUM, DK_OD_MSG_MSGID_NOT_FOUND, DK_OD_MSG_NO_VALUES_SPECIFIED, DK_OD_MSG_ONLY_ONE_VALUE_GIVEN, DK_OD_MSG_SERVER_TIMEOUT, DK_OD_MSG_UNDEFINED, DK_OD_MSG_UNKNOWN_ERROR, DK_OD_MSG_VALUE_NOT_SPECIFIED
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKDatastoreDefOD(dkDatastore ds)
          constructor
 
Method Summary
 void add(dkEntityDef entityObj)
          Adds the given entity definition object to the persistent datastore
 void addAttr(dkAttrDef attrObj)
          Adds the given attribute definition object to the persitent datastore
 dkAttrDef createAttr()
          Creates a new dkAttrDef
 dkEntityDef createEntity()
          Creates a new dkEntityDef object
 dkDatastoreAdmin datastoreAdmin()
          Get a datastore administration object for a datastore
 void del(dkEntityDef entityObj)
          Deletes the given entity definition object from the persistent datastore
 void delAttr(dkAttrDef attrObj)
          Deletes the given attribute definition object from the persistent datastore
 dkEntityDef getEntity(java.lang.String entityName)
          Gets the dkEntityDef object for the given entity name from the persistent datastore.
 int getNumFolders()
          Retrieves the number of OnDemand folders
 java.lang.String[] listAttrNames()
          Gets a list of attribute names
 dkCollection listAttrs()
          Gets a list of attributes
 dkCollection listEntities()
          Gets a list of entities from the 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 the persistent datastore
 dkCollection listFolders()
          Retrieves the folders fields for the specified folder
 dkCollection listSearchableEntities(int type)
          Gets a list of folders/applgrps from the persistent datastore
 dkCollection listSearchTemplates()
          Gets a list of folders from the persistent datastore
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreDef
clearCache, datastoreName, datastoreType, deleteEntity, getDatastore, listEntities, listEntities, listEntityNames, listEntityNames, listSearchableEntities, listSearchableEntities, listSearchableEntityNames, listSearchableEntityNames, listSearchableEntityNames, listSearchTemplateNames, retrieveEntity, setDatastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKDatastoreDefOD

public DKDatastoreDefOD(dkDatastore ds)
constructor
Parameters:
ds - a Datastore object
Method Detail

createEntity

public dkEntityDef createEntity()
                         throws DKException,
                                java.lang.Exception
Creates a new dkEntityDef object
Overrides:
createEntity in class dkAbstractDatastoreDef
Returns:
the dkEntityDef object
Throws:
DKException - if error detected
java.lang.Exception - if error detected

getEntity

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

listEntities

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

listEntityNames

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

listSearchTemplates

public dkCollection listSearchTemplates()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of folders from the persistent datastore
Overrides:
listSearchTemplates in class dkAbstractDatastoreDef
Returns:
a collection of entity definitions
Throws:
DKException - if error detected
java.lang.Exception - if error detected

listSearchableEntities

public dkCollection listSearchableEntities(int type)
                                    throws DKException,
                                           java.lang.Exception
Gets a list of folders/applgrps from the persistent datastore
Overrides:
listSearchableEntities in class dkAbstractDatastoreDef
Returns:
a collection of entity definitions
Throws:
DKException - if error detected
java.lang.Exception - if error detected

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 - the name of entity to retrieve attributes for
Returns:
a dkCollection of dkAttrDef objects
Throws:
DKException - if the entity name does not exist
java.lang.Exception - if error detected

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 - the name of entity to retrieve attribute names for
Returns:
an array of attribute names
Throws:
DKException - if the entity name does not exist
java.lang.Exception - if error detected

add

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

del

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

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
Throws:
DKException - if error detected
java.lang.Exception - if error detected

listAttrs

public dkCollection listAttrs()
                       throws DKException,
                              java.lang.Exception
Gets a list of attributes
Returns:
a dkCollection of dkAttrDef's
Throws:
DKException - if error detected
java.lang.Exception - if error detected

listAttrNames

public java.lang.String[] listAttrNames()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of attribute names
Returns:
an array of attribute names
Throws:
DKException - if error occurs
java.lang.Exception - if error detected

createAttr

public dkAttrDef createAttr()
                     throws DKException,
                            java.lang.Exception
Creates a new dkAttrDef
Returns:
the dkAttrDef object
Throws:
DKException - if error detected
java.lang.Exception - if error detected

addAttr

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

delAttr

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

getNumFolders

public int getNumFolders()
                  throws java.lang.Exception
Retrieves the number of OnDemand folders
Returns:
the the number of folders accessable to the current user

listFolders

public dkCollection listFolders()
                         throws DKException,
                                java.lang.Exception
Retrieves the folders fields for the specified folder
Returns:
a collection of folder names

EIP Java APIs

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