Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKCabinetDefDD

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

public class DKCabinetDefDD
extends dkAbstractEntityDef
implements DKConstantDD, DKMessageIdDD

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

See Also:
DKRoomDefDD, DKBinderDefDD, 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
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

DKCabinetDefDD

public DKCabinetDefDD()
Constructs a new DKDocumentDef class without owner datastore object.

DKCabinetDefDD

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

DKCabinetDefDD

public DKCabinetDefDD(int libHandle,
                      java.lang.String title,
                      int nbrBinders,
                      dkDatastore ds)
Construct a cabinet definition with all known information.
Method Detail

isSearchable

public boolean isSearchable()
Check if this cabinet can be searched for documents
Overrides:
isSearchable in class dkAbstractEntityDef
Following copied from class: com.ibm.mm.sdk.common.dkAbstractEntityDef
Returns:
true if entity is searchable

setSearchable

public void setSearchable(boolean searchable)

hasSubEntities

public boolean hasSubEntities()
                       throws DKException,
                              java.lang.Exception
Checks if this cabinet has any binders (yet) Domino.Doc connectors do not support sub-entities in this release.
Overrides:
hasSubEntities in class dkAbstractEntityDef
Returns:
false
Throws:
DKException - DKUsageError, if method called.
java.lang.Exception -  

createSubEntity

public dkEntityDef createSubEntity()
                            throws DKException,
                                   java.lang.Exception
Creates a dkEntityDefDD for a document and returns it.
Overrides:
createSubEntity in class dkAbstractEntityDef
Returns:
new dkEntityDef object.
Throws:
java.lang.Exception -  

getSubEntity

public dkEntityDef getSubEntity(java.lang.String subEntityName)
                         throws DKException,
                                java.lang.Exception
Retrieves a binder from the cabinet
Overrides:
getSubEntity in class dkAbstractEntityDef
Parameters:
subEntityName - name of document to be retrieved
Returns:
an (sub) entity object

listSubEntities

public dkCollection listSubEntities()
                             throws DKException,
                                    java.lang.Exception
Gets a list of binders for this Cabinet.
Overrides:
listSubEntities in class dkAbstractEntityDef
Returns:
a dkCollection of dkEntityDef's
Throws:
DKException -  
java.lang.Exception -  

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
Throws:
DKException - DKUsageError, if this method is called
java.lang.Exception -  

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
Returns a DKAttrDefDD with nothing in it.
Overrides:
createAttr in class dkAbstractEntityDef
Returns:
new dkAttrDef object.

getAttr

public dkAttrDef getAttr(java.lang.String attrName)
                  throws DKException,
                         java.lang.Exception
Return a DKAttrDefDD for a field name. All the profiles for this cabinet are used to search for an attr by name. Field names are searchable.

There is a potential problem with using this method! Caution! The name of an attribute is not enough to make it unique. Uniqueness requires

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 field names. Return a collection of DKAttrDefDD's. Since these are document attributes, not cabinet attributes, there will be no knowledge of the attribute's "owner" in the objects.
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. If you have previously done a "listAttrs", then the results of that list will be used to derive the list of names. If you have not previously done a "listAttrs", then that method will be called and used to derive the list of names.
Overrides:
listAttrNames in class dkAbstractEntityDef
Returns:
an array of attribute names, or null if none found.

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. Deletes this entity from the persistent store, e.g. drop table. The in-memory copy is not changed.
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. Adds the given attribute definition object to the this entity in the persistent store.
Overrides:
add in class dkAbstractEntityDef
Parameters:
attrObj - an attribute object to be added to this entity object
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. Deletes the given attribute from this entity in the persistent store.
Overrides:
del in class dkAbstractEntityDef
Parameters:
attrObj - an attribute object to be deleted from this entity object
Throws:
DKException - DKUsageError, if this method is called.
java.lang.Exception -  

getCabinetTitle

public java.lang.String getCabinetTitle()

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

EIP Java APIs

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