Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatastoreDefDES

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

public class DKDatastoreDefDES
extends dkAbstractDatastoreDef
implements DKMessageId, DKConstantDES, java.io.Serializable

This class defines methods to access DES datastore information

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDES
DK_DES_APPID_HANDLE, DK_DES_APPINFO_HANDLE, DK_DES_BROKER_HANDLE, DK_DES_CMBROOT, DK_DES_DATASOURCE, DK_DES_DLL_NAME, DK_DES_DSTYPE, DK_DES_GQL_QL_TYPE, DK_DES_INIFILE, DK_DES_ITEMID_SEPARATOR, DK_DES_PORT, DK_DES_PROPERTY_DISPNAME, DK_DES_PROPERTY_HELPTEXT, DK_DES_PROPERTY_LANGUAGE, DK_DES_PROPERTY_RETRIEVABLE, DK_DES_PROPERTY_SEARCHABLE, DK_DES_PROPERTY_SEARCHOPERATOR, DK_DES_PROPERTY_VALUECOUNT, DK_DES_REPOSITORIES_HANDLE, DK_DES_RMIREF_HANDLE, DK_DES_SESSION_HANDLE, DK_FILESYSTEM_ENTITY, DK_NOTES_ENTITY, DK_NOTESPUMP_ENTITY, DK_WEB_ENTITY
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKDatastoreDefDES(dkDatastore ds)
          Constructs a new DKDatastoreDefDES object with a given datastore
 
Method Summary
 void add(dkEntityDef entityObj)
          Adds the given entity object to persitent datastore
 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
 dkEntityDef getEntity(java.lang.String entityName)
          Gets the dkEntityDef object for the given entity name from persistent datastore.
 java.lang.String getEntitySourceType(java.lang.String entityName)
          getEntitySourceType will return the link type of specified source
 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[] listEntityCategoryNames()
          listEntityCategoryNames will return a String array of Category names under the specified application.
 java.lang.String[] listEntityNames()
          Gets a list of entity names from persistent datastore
 java.lang.String[] listEntityNamesByCategory(java.lang.String categoryName)
          listEntityNamesByCategory will return a String array of Source names names under the specified category in a specified application.
 java.lang.String[] listEntityNamesByCategoryAndType(java.lang.String categoryName, java.lang.String entitysourceType)
          listEntityNamesByCategoryAndType will return a String array of Source names names under the specified category in a specified application of a particulare link type.
 java.lang.String[] listFileSystemEntities()
          listFileSystemEntities will list the file system sources configured.
 
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

DKDatastoreDefDES

public DKDatastoreDefDES(dkDatastore ds)
Constructs a new DKDatastoreDefDES object with a given datastore
Parameters:
ds - reference to the datastore object
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

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

listEntityCategoryNames

public java.lang.String[] listEntityCategoryNames()
                                           throws DKException,
                                                  java.lang.Exception
listEntityCategoryNames will return a String array of Category names under the specified application.
Returns:
String[]

listEntityNamesByCategory

public java.lang.String[] listEntityNamesByCategory(java.lang.String categoryName)
                                             throws DKException,
                                                    java.lang.Exception
listEntityNamesByCategory will return a String array of Source names names under the specified category in a specified application.
Parameters:
categoryName - - category name of interest
Returns:
String[]

listEntityNamesByCategoryAndType

public java.lang.String[] listEntityNamesByCategoryAndType(java.lang.String categoryName,
                                                           java.lang.String entitysourceType)
                                                    throws DKException,
                                                           java.lang.Exception
listEntityNamesByCategoryAndType will return a String array of Source names names under the specified category in a specified application of a particulare link type.
Parameters:
categoryName - - category name of interest
entitySourceType - - linkType name of interest
Returns:
String[]

getEntitySourceType

public java.lang.String getEntitySourceType(java.lang.String entityName)
                                     throws DKException,
                                            java.lang.Exception
getEntitySourceType will return the link type of specified source
Parameters:
entityName - - source name of interest
Returns:
String

listFileSystemEntities

public java.lang.String[] listFileSystemEntities()
                                          throws DKException,
                                                 java.lang.Exception
listFileSystemEntities will list the file system sources configured.
Parameters:
void -  
Returns:
String[] string array with list of file system sources

EIP Java APIs

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