|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractDatastoreDef | +--com.ibm.mm.sdk.common.DKDatastoreDefDD
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.
dkEntityDef
,
DKDocumentDefDD
,
com.ibm.mm.sdk.common.DKDatastoreIP
, Serialized FormFields 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 |
public DKDatastoreDefDD(dkDatastore ds)
Method Detail |
public dkCollection listEntities() throws DKException, java.lang.Exception
listEntities
in class dkAbstractDatastoreDef
public java.lang.String[] listEntityNames() throws DKException, java.lang.Exception
listEntityNames
in class dkAbstractDatastoreDef
public dkCollection listSearchableEntities() throws DKException, java.lang.Exception
listSearchableEntities
in class dkAbstractDatastoreDef
public java.lang.String[] listSearchableEntityNames() throws DKException, java.lang.Exception
listSearchableEntityNames
in class dkAbstractDatastoreDef
public dkEntityDef createEntity() throws DKException, java.lang.Exception
createEntity
in class dkAbstractDatastoreDef
DKDocumentDefDD
public dkEntityDef getEntity(java.lang.String entityName) throws DKException, java.lang.Exception
getEntity
in class dkAbstractDatastoreDef
entityName
- name of datastore definition to retrieveDKException
- name does not exist.public dkCollection listCabinets() throws DKException, java.lang.Exception
public java.lang.String[] listCabinetNames() throws DKException, java.lang.Exception
public dkEntityDef getCabinet(java.lang.String cabinetName) throws DKException, java.lang.Exception
entityName
- name of datastore definition to retrieveDKException
- name does not exist.public dkCollection listRooms() throws DKException, java.lang.Exception
DKException
- if an error occurs.public java.lang.String[] listRoomNames() throws DKException, java.lang.Exception
DKException
- if an error occurs.public dkCollection listEntityAttrs(java.lang.String aString) throws DKException, java.lang.Exception
listEntityAttrs
in class dkAbstractDatastoreDef
entityName
- name of the entity to retrieve the attributes forDKCabinetDefDD
public java.lang.String[] listEntityAttrNames(java.lang.String entityName) throws DKException
listEntityAttrNames
in class dkAbstractDatastoreDef
entityName
- ignored.public void add(dkEntityDef entityObj) throws DKException
add
in class dkAbstractDatastoreDef
entityObj
- entity object to be added.DKException
- if the entity object is invalid
on the back-end server while adding the enityt.public void del(dkEntityDef entityObj) throws DKException
del
in class dkAbstractDatastoreDef
entityObj
- the entity object to be deleted.DKException
- if the entityObj is invalid or does not exist on
the backend server.public void del(java.lang.String entityName) throws DKException
entityName
- the name of the entity object to be deleted.DKException
- if the entityName is invalid or the associated entity
does not exist on the server.public java.lang.String toString()
toString
in class java.lang.Object
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |