Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKRoomDefDD

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractEntityDef
        |
        +--com.ibm.mm.sdk.common.DKRoomDefDD
All Implemented Interfaces:
DKConstant, DKConstantDD, dkEntityDef, DKMessageId, DKMessageIdDD, java.io.Serializable

public class DKRoomDefDD
extends dkAbstractEntityDef
implements DKConstantDD, DKMessageIdDD

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).

See Also:
DKDatastoreDD, DKCabinetDefDD, 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
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

DKRoomDefDD

public DKRoomDefDD()
Constructs a new DKRoomDef class without owner datastore object.

DKRoomDefDD

public DKRoomDefDD(dkDatastore ds)
Constructs a new DKRoomDef class with owner datastore object
Parameters:
ds - reference to owner datastore object

DKRoomDefDD

public DKRoomDefDD(int libraryHandle,
                   java.lang.String roomTitle,
                   int nbrCabinets,
                   dkDatastore ds)
Constructs a new DKRoomDefDD with meaningful data.
Parameters:
libraryHandle - Domino.Doc Library Dispatch object
roomTitle - Domino.Doc Room Title
isValid - whether or not this room is valid
Method Detail

isSearchable

public boolean isSearchable()
                     throws DKException,
                            java.lang.Exception
Get boolean telling whether or not this entity can be searched.
Overrides:
isSearchable in class dkAbstractEntityDef
Returns:
False, you cannot search for documents in a binder.

getRoomTitle

public java.lang.String getRoomTitle()
Get Title for this room.
Returns:
String, which can be null if title is null.

hasSubEntities

public boolean hasSubEntities()
                       throws DKException,
                              java.lang.Exception
Checks if this Room has any cabinets in it.
Overrides:
hasSubEntities in class dkAbstractEntityDef
Returns:
If there are no Domino.Doc cabinets in this room, then false is returned; otherwise, true is returned.

createSubEntity

public dkEntityDef createSubEntity()
                            throws DKException,
                                   java.lang.Exception
Creates an entity def object for a cabinet. Object knows it's datastore.
Overrides:
createSubEntity in class dkAbstractEntityDef
Throws:
DKException - DKUsageError, if this method is called
java.lang.Exception -  

getSubEntity

public dkEntityDef getSubEntity(java.lang.String cabinetTitle)
                         throws DKException,
                                java.lang.Exception
Retrieves a cabinet from this room.
Overrides:
getSubEntity in class dkAbstractEntityDef
Parameters:
subEntityName - name of attribute to be retrieved
Returns:
a DKCabinetDefDD object.
Throws:
DKException - (DKUsageError) is thrown if Cabinet does not exist.
See Also:
DKCabinetDefDD

listSubEntities

public dkCollection listSubEntities()
                             throws DKException,
                                    java.lang.Exception
Get a list of cabinets for this room.
Overrides:
listSubEntities in class dkAbstractEntityDef
Returns:
a DKSequentialCollection of DKCabinetDefDD's
See Also:
DKCabinetDefDD, DKSequentialCollection

listSubEntityNames

public java.lang.String[] listSubEntityNames()
                                      throws DKException,
                                             java.lang.Exception
Gets a list of sub entity names
Overrides:
listSubEntityNames in class dkAbstractEntityDef
Returns:
an array of entity names

add

public void add(dkEntityDef subEntityObj)
         throws DKException,
                java.lang.Exception
Not supported in this release. Adds the sub entity definition object to the this entity in the persistent store.
Overrides:
add in class dkAbstractEntityDef
Parameters:
subEntityObj - an sub entity object to be added to this entity object
Throws:
DKException - DKUsageError, if this method is called
java.lang.Exception -  

del

public void del(dkEntityDef subEntityObj)
         throws DKException,
                java.lang.Exception
Not supported in this release. Delete the sub entity definition object from this entity in the persistent store.
Overrides:
del in class dkAbstractEntityDef
Parameters:
subEntityObj - an sub entity object to be deleted from this entity object
Throws:
DKException - DKUsageError, if this method is called
java.lang.Exception -  

createAttr

public dkAttrDef createAttr()
                     throws DKException,
                            java.lang.Exception
dkAttrDefDD objects don't make sense for rooms. Creates new dkAttrDef and returns it to caller.
Overrides:
createAttr in class dkAbstractEntityDef
Returns:
new dkAttrDef object.
Throws:
DKException - DKUsageError, if this method is called.
java.lang.Exception -  

getAttr

public dkAttrDef getAttr(java.lang.String attrName)
                  throws DKException,
                         java.lang.Exception
dkAttrDefDD objects don't make sense for rooms
Overrides:
getAttr in class dkAbstractEntityDef
Parameters:
attrName - name of attribute to be retrieved
Returns:
an attribute object

listAttrs

public dkCollection listAttrs()
                       throws DKException,
                              java.lang.Exception
Gets a list of attributes -- none for rooms
Overrides:
listAttrs in class dkAbstractEntityDef
Returns:
a dkCollection of dkAttrDef's
Throws:
DKException - if error occurs

listAttrNames

public java.lang.String[] listAttrNames()
                                 throws DKException,
                                        java.lang.Exception
Gets a list of attributes -- none for rooms
Overrides:
listAttrNames in class dkAbstractEntityDef
Returns:
an array of attribute names
Throws:
DKException - if error occurs

add

public void add()
         throws DKException,
                java.lang.Exception
Not supported in this release. Adds this entity definition to the persistent store, i.e. make this entity persistent.
Overrides:
add in class dkAbstractEntityDef
Throws:
DKException - DKUsageError, if this method is called.
java.lang.Exception -  

del

public void del()
         throws DKException,
                java.lang.Exception
Not supported in this release.
Overrides:
del in class dkAbstractEntityDef
Throws:
DKException - DKUsageError, if this method is called
java.lang.Exception -  

add

public void add(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Not supported in this release.
Overrides:
add in class dkAbstractEntityDef
Throws:
DKException - DKUsageError, if this method is called.
java.lang.Exception -  

del

public void del(dkAttrDef attrObj)
         throws DKException,
                java.lang.Exception
Not supported in this release.
Overrides:
del in class dkAbstractEntityDef
Throws:
DKException - DKUsageError, if this method is called.
java.lang.Exception -  

toString

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

EIP Java APIs

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