|
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.dkAbstractEntityDef | +--com.ibm.mm.sdk.common.DKRoomDefDD
This class defines methods to get Domino.Doc Room information. Access to these objects is through DKDatastoreDD, listEntities method. Domino.Doc libraries have rooms, which contain cabinets. This class also:
Any method not supported by Domino.Doc in this release will throw a DKMSG_NOTIMP DKUsageError (... not implemented).
DKDatastoreDD
,
DKCabinetDefDD
, 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 | |
DKRoomDefDD()
Constructs a new DKRoomDef class without owner datastore object. |
|
DKRoomDefDD(dkDatastore ds)
Constructs a new DKRoomDef class with owner datastore object |
|
DKRoomDefDD(int libraryHandle,
java.lang.String roomTitle,
int nbrCabinets,
dkDatastore ds)
Constructs a new DKRoomDefDD with meaningful data. |
Method Summary | |
void |
add()
Not supported in this release. |
void |
add(dkAttrDef attrObj)
Not supported in this release. |
void |
add(dkEntityDef subEntityObj)
Not supported in this release. |
dkAttrDef |
createAttr()
dkAttrDefDD objects don't make sense for rooms. |
dkEntityDef |
createSubEntity()
Creates an entity def object for a cabinet. |
void |
del()
Not supported in this release. |
void |
del(dkAttrDef attrObj)
Not supported in this release. |
void |
del(dkEntityDef subEntityObj)
Not supported in this release. |
dkAttrDef |
getAttr(java.lang.String attrName)
dkAttrDefDD objects don't make sense for rooms |
java.lang.String |
getRoomTitle()
Get Title for this room. |
dkEntityDef |
getSubEntity(java.lang.String cabinetTitle)
Retrieves a cabinet from this room. |
boolean |
hasSubEntities()
Checks if this Room has any cabinets in it. |
boolean |
isSearchable()
Get boolean telling whether or not this entity can be searched. |
java.lang.String[] |
listAttrNames()
Gets a list of attributes -- none for rooms |
dkCollection |
listAttrs()
Gets a list of attributes -- none for rooms |
dkCollection |
listSubEntities()
Get a list of cabinets for this room. |
java.lang.String[] |
listSubEntityNames()
Gets a list of sub entity names |
java.lang.String |
toString()
Get a string representation of this object. |
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractEntityDef |
addAttr, addSubEntity, clearCache, datastoreName, datastoreType, deleteAttr, deleteSubEntity, getDatastore, getDescription, getName, getParentEntityName, getType, isTextSearchable, removeAttr, removeSubEntity, retrieveAttr, retrieveSubEntity, setDatastore, setDescription, setName, setParentEntityName, setTextSearchable, setType |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public DKRoomDefDD()
public DKRoomDefDD(dkDatastore ds)
ds
- reference to owner datastore objectpublic DKRoomDefDD(int libraryHandle, java.lang.String roomTitle, int nbrCabinets, dkDatastore ds)
libraryHandle
- Domino.Doc Library Dispatch objectroomTitle
- Domino.Doc Room TitleisValid
- whether or not this room is validMethod Detail |
public boolean isSearchable() throws DKException, java.lang.Exception
isSearchable
in class dkAbstractEntityDef
public java.lang.String getRoomTitle()
public boolean hasSubEntities() throws DKException, java.lang.Exception
hasSubEntities
in class dkAbstractEntityDef
public dkEntityDef createSubEntity() throws DKException, java.lang.Exception
createSubEntity
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is calledjava.lang.Exception
- public dkEntityDef getSubEntity(java.lang.String cabinetTitle) throws DKException, java.lang.Exception
getSubEntity
in class dkAbstractEntityDef
subEntityName
- name of attribute to be retrievedDKException
- (DKUsageError) is thrown if Cabinet does not exist.DKCabinetDefDD
public dkCollection listSubEntities() throws DKException, java.lang.Exception
listSubEntities
in class dkAbstractEntityDef
DKCabinetDefDD
,
DKSequentialCollection
public java.lang.String[] listSubEntityNames() throws DKException, java.lang.Exception
listSubEntityNames
in class dkAbstractEntityDef
public void add(dkEntityDef subEntityObj) throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
subEntityObj
- an sub entity object to be added to this
entity objectDKException
- DKUsageError, if this method is calledjava.lang.Exception
- public void del(dkEntityDef subEntityObj) throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
subEntityObj
- an sub entity object to be deleted from this
entity objectDKException
- DKUsageError, if this method is calledjava.lang.Exception
- public dkAttrDef createAttr() throws DKException, java.lang.Exception
createAttr
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is called.java.lang.Exception
- public dkAttrDef getAttr(java.lang.String attrName) throws DKException, java.lang.Exception
getAttr
in class dkAbstractEntityDef
attrName
- name of attribute to be retrievedpublic dkCollection listAttrs() throws DKException, java.lang.Exception
listAttrs
in class dkAbstractEntityDef
DKException
- if error occurspublic java.lang.String[] listAttrNames() throws DKException, java.lang.Exception
listAttrNames
in class dkAbstractEntityDef
DKException
- if error occurspublic void add() throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is called.java.lang.Exception
- public void del() throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is calledjava.lang.Exception
- public void add(dkAttrDef attrObj) throws DKException, java.lang.Exception
add
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is called.java.lang.Exception
- public void del(dkAttrDef attrObj) throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is called.java.lang.Exception
- 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 |