Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKDatastoreDefDD

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

public class DKDatastoreDefDD
extends dkAbstractDatastoreDef
implements DKConstantDD, DKMessageIdDD

This class stores the Domino.Doc datastore meta-data and provides methods to access this data. The meta-data is represented as a collection of dkEntityDefs of type DKDocumentDefDD.

See Also:
dkEntityDef, DKDocumentDefDD, com.ibm.mm.sdk.common.DKDatastoreIP, Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDD
copyright, DK_ACTYPE_DD, DK_DD_APPEND, DK_DD_ATTR, DK_DD_BINDER, DK_DD_BLOB, DK_DD_CABINET, DK_DD_CREATE, DK_DD_CREATE_DATE, DK_DD_DATASTORE_EXT, DK_DD_DEFAULT_MIMETYPE, DK_DD_DLL_NAME, DK_DD_DOC_TYPE, DK_DD_DOCUMENT, DK_DD_DS_API_NAME, DK_DD_DSTYPE, DK_DD_FIELD, DK_DD_FILENAME, DK_DD_KEYWORD, DK_DD_LIBRARY, DK_DD_OPT_CONTENT, DK_DD_OPT_CONTENT_ATTRONLY, DK_DD_OPT_CONTENT_NO, DK_DD_OPT_CONTENT_YES, DK_DD_OPT_LIMIT, DK_DD_OPT_NO_LIMIT, DK_DD_OPT_RUN_FINALIZE_ON_EXIT, DK_DD_OPT_RUN_FINALIZE_ON_EXIT_NO, DK_DD_OPT_RUN_FINALIZE_ON_EXIT_YES, DK_DD_OPT_SEARCH_OPTION, DK_DD_OPT_SEARCH_OPTION_STEMS, DK_DD_OPT_SEARCH_OPTION_THESAURUS, DK_DD_OPT_SORT_ORDER, DK_DD_OPT_SORT_ORDER_DATE_ASC, DK_DD_OPT_SORT_ORDER_DATE_DES, DK_DD_OPT_SORT_ORDER_SCORES, DK_DD_OVERWRITE, DK_DD_PID_DOC_EXT, DK_DD_PID_DOC_ID, DK_DD_PID_DOC_ID_CNT, DK_DD_PROFILE, DK_DD_ROOM, DK_DD_SERVER_TYPE, DK_DD_TITLE, DK_DD_UNKNOWN
 
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.DKMessageIdDD
copyright, DK_DD_MSG_MSGID_DOMDOC, DK_DD_MSG_MSGID_GOVERNOR, DK_DD_MSG_MSGID_NO_ATTR_OBJ, DK_DD_MSG_MSGID_NO_BINDER_OBJ, DK_DD_MSG_MSGID_NO_CABINET_OBJ, DK_DD_MSG_MSGID_NO_DOCUMENT_OBJ, DK_DD_MSG_MSGID_NO_MESSAGE, DK_DD_MSG_MSGID_NO_ROOM_OBJ, DK_DD_MSG_MSGID_NO_SUCCESS, DK_DD_MSG_MSGID_NUL_PARAM
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKDatastoreDefDD(dkDatastore ds)
          Constructs and initializes an ImagePlus/390 datastore definition.
 
Method Summary
 void add(dkEntityDef entityObj)
          Adds the given entity object to the datastore.
 dkEntityDef createEntity()
          Creates a entity definition for a room.
 void del(dkEntityDef entityObj)
          Deletes the given entity object from the datastore.
 void del(java.lang.String entityName)
          Deletes the entity object with the specified name from the datastore.
 dkEntityDef getCabinet(java.lang.String cabinetName)
          Get a cabinet from a Domino.Doc library
 dkEntityDef getEntity(java.lang.String entityName)
          Get a room from a Domino.Doc library
 java.lang.String[] listCabinetNames()
          Get a list of cabinet titles from Domino.Doc
 dkCollection listCabinets()
          Get a list of Cabinets from a Domino.Doc library.
 dkCollection listEntities()
          Create and retrieve a collecton of subEntities of this datastore.
 java.lang.String[] listEntityAttrNames(java.lang.String entityName)
          A DominoDoc library doesn't have much to say in the way of DKAttrDefDD's.
 dkCollection listEntityAttrs(java.lang.String aString)
          A DominoDoc library doesn't have much to say in the way of DKAttrDefDD's.
 java.lang.String[] listEntityNames()
          Get an array of room names.
 java.lang.String[] listRoomNames()
          Returns a list of entity names for this datastore.
 dkCollection listRooms()
          Get a list of Rooms from a Domino.Doc library.
 dkCollection listSearchableEntities()
          Create and retrieve a collecton of searchable entities.
 java.lang.String[] listSearchableEntityNames()
          Get an array of cabinet names
 java.lang.String toString()
          Get a string representation of this class
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractDatastoreDef
clearCache, datastoreAdmin, datastoreName, datastoreType, deleteEntity, getDatastore, listEntities, listEntities, listEntityNames, listEntityNames, listSearchableEntities, listSearchableEntities, listSearchableEntityNames, listSearchableEntityNames, listSearchTemplateNames, listSearchTemplates, retrieveEntity, setDatastore
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DKDatastoreDefDD

public DKDatastoreDefDD(dkDatastore ds)
Constructs and initializes an ImagePlus/390 datastore definition.
Method Detail

listEntities

public dkCollection listEntities()
                          throws DKException,
                                 java.lang.Exception
Create and retrieve a collecton of subEntities of this datastore. This returns a collection of dkEntityDefs for Rooms.
Overrides:
listEntities in class dkAbstractDatastoreDef
Returns:
dkCollection of dkEntityDefs for rooms.

listEntityNames

public java.lang.String[] listEntityNames()
                                   throws DKException,
                                          java.lang.Exception
Get an array of room names.
Overrides:
listEntityNames in class dkAbstractDatastoreDef
Returns:
String[] room names

listSearchableEntities

public dkCollection listSearchableEntities()
                                    throws DKException,
                                           java.lang.Exception
Create and retrieve a collecton of searchable entities. This returns a collection of dkEntityDefs for Cabinets.
Overrides:
listSearchableEntities in class dkAbstractDatastoreDef
Returns:
dkCollection of dkEntityDefs for cabinets.

listSearchableEntityNames

public java.lang.String[] listSearchableEntityNames()
                                             throws DKException,
                                                    java.lang.Exception
Get an array of cabinet names
Overrides:
listSearchableEntityNames in class dkAbstractDatastoreDef
Returns:
String[] of cabinet names

createEntity

public dkEntityDef createEntity()
                         throws DKException,
                                java.lang.Exception
Creates a entity definition for a room. Returns a new dkEntityDef object.
Overrides:
createEntity in class dkAbstractDatastoreDef
Returns:
a new dkEntityDef of type DKRoomDefDD
See Also:
DKDocumentDefDD

getEntity

public dkEntityDef getEntity(java.lang.String entityName)
                      throws DKException,
                             java.lang.Exception
Get a room from a Domino.Doc library
Overrides:
getEntity in class dkAbstractDatastoreDef
Parameters:
entityName - name of datastore definition to retrieve
Returns:
dkEntityDef object contains data about the given entityName.
Throws:
DKException - name does not exist.

listCabinets

public dkCollection listCabinets()
                          throws DKException,
                                 java.lang.Exception
Get a list of Cabinets from a Domino.Doc library. Cabinets can be searched to get document collections.
Returns:
a DKSequentialCollection of Entity definitions, dkEntityDef

listCabinetNames

public java.lang.String[] listCabinetNames()
                                    throws DKException,
                                           java.lang.Exception
Get a list of cabinet titles from Domino.Doc
Returns:
a String array of cabinet Titles

getCabinet

public dkEntityDef getCabinet(java.lang.String cabinetName)
                       throws DKException,
                              java.lang.Exception
Get a cabinet from a Domino.Doc library
Parameters:
entityName - name of datastore definition to retrieve
Returns:
dkEntityDef object contains data about the given entityName.
Throws:
DKException - name does not exist.

listRooms

public dkCollection listRooms()
                       throws DKException,
                              java.lang.Exception
Get a list of Rooms from a Domino.Doc library. Rooms are a subEntity of a Domino.Doc library.
Returns:
a DKSequentialCollection of entity definitions, dkEntityDef
Throws:
DKException - if an error occurs.

listRoomNames

public java.lang.String[] listRoomNames()
                                 throws DKException,
                                        java.lang.Exception
Returns a list of entity names for this datastore.
Returns:
an array of entity names
Throws:
DKException - if an error occurs.

listEntityAttrs

public dkCollection listEntityAttrs(java.lang.String aString)
                             throws DKException,
                                    java.lang.Exception
A DominoDoc library doesn't have much to say in the way of DKAttrDefDD's. Look in the cabinet for useful information.
Overrides:
listEntityAttrs in class dkAbstractDatastoreDef
Parameters:
entityName - name of the entity to retrieve the attributes for
Returns:
a dkCollection of dkAttrDef objects
See Also:
DKCabinetDefDD

listEntityAttrNames

public java.lang.String[] listEntityAttrNames(java.lang.String entityName)
                                       throws DKException
A DominoDoc library doesn't have much to say in the way of DKAttrDefDD's. Look in the cabinet for useful information.
Overrides:
listEntityAttrNames in class dkAbstractDatastoreDef
Parameters:
entityName - ignored.
Returns:
null

add

public void add(dkEntityDef entityObj)
         throws DKException
Adds the given entity object to the datastore.
Overrides:
add in class dkAbstractDatastoreDef
Parameters:
entityObj - entity object to be added.
Throws:
DKException - if the entity object is invalid on the back-end server while adding the enityt.

del

public void del(dkEntityDef entityObj)
         throws DKException
Deletes the given entity object from the 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 on the backend server.

del

public void del(java.lang.String entityName)
         throws DKException
Deletes the entity object with the specified name from the datastore.
Parameters:
entityName - the name of the entity object to be deleted.
Throws:
DKException - if the entityName is invalid or the associated entity does not exist on the server.

toString

public java.lang.String toString()
Get a string representation of this class
Overrides:
toString in class java.lang.Object
Returns:
a string suitable for debugging purposes

EIP Java APIs

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