Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKBinderDefDD

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

public class DKBinderDefDD
extends dkAbstractEntityDef
implements DKConstantDD, DKMessageIdDD

This class defines methods to get Domino.Doc Binder information. Access to these objects is through DKCabinetDefDD, listSubEntities method. Domino.Doc cabinets have binders, which contain documents. This class also:

Any method not supported by Domino.Doc in this release will throw a DKMSG_NOTIMP DKUsageError (... not implemented).

See Also:
DKCabinetDefDD, DKDocumentDefDD, 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
DKBinderDefDD()
          Constructs a new DKDocumentDef class without owner datastore object.
DKBinderDefDD(dkDatastore ds)
          Constructs a new DKDocumentDef class with owner datastore object
DKBinderDefDD(int libHandle, java.lang.String cabinetTitle, java.lang.String title, int nbrDocuments, dkDatastore ds)
          Construct a binder definition with all known information.
 
Method Summary
 void add()
          Not implemented...
 void add(dkAttrDef attrObj)
          Not implemented...
 void add(dkEntityDef subEntityObj)
          Not implemented...
 dkAttrDef createAttr()
          Not implemented...
 dkEntityDef createSubEntity()
          Not supported, because this would only be used for CRUD.
 void del()
          Not implemented...
 void del(dkAttrDef attrObj)
          Not implemented...
 void del(dkEntityDef subEntityObj)
          Not implemented...
 dkAttrDef getAttr(java.lang.String attrName)
          Retrieves an attribute object from a given attribute name Note: Domino.Doc Binders' only attr is cabinet title.
 java.lang.String getBinderTitle()
          Return title for this binder
 dkEntityDef getSubEntity(java.lang.String subEntityName)
          Retrieves a sub entity object from a given sub entity name.
 boolean hasSubEntities()
          Checks if this entity has sub entity objects.
 boolean isSearchable()
          Get boolean telling whether or not this entity can be searched.
 java.lang.String[] listAttrNames()
          Gets a list of attributes
 dkCollection listAttrs()
          Gets a list of attributes
 dkCollection listSubEntities()
          List documents
 java.lang.String[] listSubEntityNames()
          Gets a list of document names for this binder
 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

DKBinderDefDD

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

DKBinderDefDD

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

DKBinderDefDD

public DKBinderDefDD(int libHandle,
                     java.lang.String cabinetTitle,
                     java.lang.String title,
                     int nbrDocuments,
                     dkDatastore ds)
Construct a binder definition with all known information.
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.

hasSubEntities

public boolean hasSubEntities()
                       throws DKException,
                              java.lang.Exception
Checks if this entity has sub entity objects.
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
Not supported, because this would only be used for CRUD. Creates new dkEntityDef and returns it to caller.
Overrides:
createSubEntity in class dkAbstractEntityDef
Returns:
new dkEntityDef object.
Throws:
DKException - DKUsageError, if this method is called
java.lang.Exception -  

getSubEntity

public dkEntityDef getSubEntity(java.lang.String subEntityName)
                         throws DKException,
                                java.lang.Exception
Retrieves a sub entity object from a given sub entity name. This method is provided to support multi-level document model.
Overrides:
getSubEntity in class dkAbstractEntityDef
Parameters:
subEntityName - name of attribute to be retrieved
Returns:
an (sub) entity object
Throws:
DKException - DKUsageError, if this method is called
java.lang.Exception -  

listSubEntities

public dkCollection listSubEntities()
                             throws DKException,
                                    java.lang.Exception
List documents
Overrides:
listSubEntities in class dkAbstractEntityDef
Returns:
a dkCollection of dkEntityDef's
Throws:
DKException - DKUsageError, if this method is called.
java.lang.Exception -  

listSubEntityNames

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

add

public void add(dkEntityDef subEntityObj)
         throws DKException,
                java.lang.Exception
Not implemented... 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 implemented... 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
Not implemented... 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
Retrieves an attribute object from a given attribute name Note: Domino.Doc Binders' only attr is cabinet title.
Overrides:
getAttr in class dkAbstractEntityDef
Parameters:
attrName - name of attribute to be retrieved
Returns:
a DKAttrDefDD for cabinet title.

listAttrs

public dkCollection listAttrs()
                       throws DKException,
                              java.lang.Exception
Gets a list of attributes
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
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 implemented... 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 implemented... 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 implemented... 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 implemented... 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 -  

getBinderTitle

public java.lang.String getBinderTitle()
Return title for this binder

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.