|
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.DKCabinetDefDD
This class defines methods to get Domino.Doc Cabinet information. Access to these objects is through DKRoomDefDD, listSubEntities method. Domino.Doc rooms have cabinets, which contain binders. This class also:
Any method not supported by Domino.Doc in this release will throw a DKMSG_NOTIMP DKUsageError (... not implemented).
DKRoomDefDD
,
DKBinderDefDD
, 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 | |
DKCabinetDefDD()
Constructs a new DKDocumentDef class without owner datastore object. |
|
DKCabinetDefDD(dkDatastore ds)
Constructs a new DKDocumentDef class with owner datastore object |
|
DKCabinetDefDD(int libHandle,
java.lang.String title,
int nbrBinders,
dkDatastore ds)
Construct a cabinet definition with all known information. |
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()
Returns a DKAttrDefDD with nothing in it. |
dkEntityDef |
createSubEntity()
Creates a dkEntityDefDD for a document and returns it. |
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)
Return a DKAttrDefDD for a field name. |
java.lang.String |
getCabinetTitle()
|
dkEntityDef |
getSubEntity(java.lang.String subEntityName)
Retrieves a binder from the cabinet |
boolean |
hasSubEntities()
Checks if this cabinet has any binders (yet) Domino.Doc connectors do not support sub-entities in this release. |
boolean |
isSearchable()
Check if this cabinet can be searched for documents |
java.lang.String[] |
listAttrNames()
Gets a list of attributes. |
dkCollection |
listAttrs()
Gets a list of field names. |
dkCollection |
listSubEntities()
Gets a list of binders for this Cabinet. |
java.lang.String[] |
listSubEntityNames()
Gets a list of sub entity names |
void |
setSearchable(boolean searchable)
|
java.lang.String |
toString()
|
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 DKCabinetDefDD()
public DKCabinetDefDD(dkDatastore ds)
ds
- reference to owner datastore objectpublic DKCabinetDefDD(int libHandle, java.lang.String title, int nbrBinders, dkDatastore ds)
Method Detail |
public boolean isSearchable()
isSearchable
in class dkAbstractEntityDef
com.ibm.mm.sdk.common.dkAbstractEntityDef
public void setSearchable(boolean searchable)
public boolean hasSubEntities() throws DKException, java.lang.Exception
hasSubEntities
in class dkAbstractEntityDef
DKException
- DKUsageError, if method called.java.lang.Exception
- public dkEntityDef createSubEntity() throws DKException, java.lang.Exception
createSubEntity
in class dkAbstractEntityDef
java.lang.Exception
- public dkEntityDef getSubEntity(java.lang.String subEntityName) throws DKException, java.lang.Exception
getSubEntity
in class dkAbstractEntityDef
subEntityName
- name of document to be retrievedpublic dkCollection listSubEntities() throws DKException, java.lang.Exception
listSubEntities
in class dkAbstractEntityDef
DKException
- java.lang.Exception
- public java.lang.String[] listSubEntityNames() throws DKException, java.lang.Exception
listSubEntityNames
in class dkAbstractEntityDef
DKException
- DKUsageError, if this method is calledjava.lang.Exception
- 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
public dkAttrDef getAttr(java.lang.String attrName) throws DKException, java.lang.Exception
There is a potential problem with using this method! Caution! The name of an attribute is not enough to make it unique. Uniqueness requires
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
public 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
attrObj
- an attribute object to be added to this entity objectDKException
- DKUsageError, if this method is called.java.lang.Exception
- public void del(dkAttrDef attrObj) throws DKException, java.lang.Exception
del
in class dkAbstractEntityDef
attrObj
- an attribute object to be deleted from this entity objectDKException
- DKUsageError, if this method is called.java.lang.Exception
- public java.lang.String getCabinetTitle()
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 |