Index

DKBinderDefDD

Purpose:

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.

Class summary:

class DKBinderDefDD : public DKEntityDefDD
{
  public:
    DKBinderDefDD();
    DKBinderDefDD(dkDatastore* ds);
    DKBinderDefDD( void* libHandle,
                   DKString cabinetTitle,
                   DKString title,
                   int nbrDocuments,
                   dkDatastore* ds );
 
    ~DKBinderDefDD();
 
    DKString    getBinderTitle();
    dkAttrDef*     createAttr();
    dkAttrDef*     getAttr(const char* attrName);
    dkCollection*  listAttrs();
    DKString*      listAttrNames(long& arraySize);
    DKBoolean      isSearchable();
    void           setHandle( void* libHandle );
    void           setCabinetTitle( const char* CabinetTitle );
    DKBoolean      hasSubEntities();
    dkCollection*  listSubEntities();
    DKString*      listSubEntityNames();
};

Members:

Constructors and destructor
The first constructor constructs a new DKDocumentDef class without owner datastore object. The second constructor constructs a new DKDocumentDef class with an owner datastore object. The third constructor constructs a binder definition with all known information.
    DKBinderDefDD();
    DKBinderDefDD(dkDatastore* ds);
    DKBinderDefDD( void* libHandle,
                   DKString cabinetTitle,
                   DKString title,
                   int nbrDocuments,
                   dkDatastore* ds );
 
    ~DKBinderDefDD();
 

Member functions

getBinderTitle
Gets the title for this binder.
    DKString getBinderTitle();
 

createAttr
Creates a new dkAttrDef and returns it to the caller.
    dkAttrDef* createAttr();
 

getAttr
Retrieves an attribute object from a given attribute name. A Domino.Doc binder's only attribute is the cabinet title.
    dkAttrDef* getAttr(const char* attrName);
 

listAttrs
Gets a DKSequentialCollection of objects of type DKAttrDefDD.
    dkCollection*  listAttrs();
 

listAttrNames
Gets a list of attribute names.
    DKString* listAttrNames(long& arraySize);
 

isSearchable
Gets a boolean result indicating whether this entity can be searched or not.
    DKBoolean isSearchable();
 

setHandle
Sets the library handle.
    void setHandle( void* libHandle );
 

setCabinetTitle
Sets the Domino.Doc cabinet title in this document object. The Domino.Doc library is not updated.
    void setCabinetTitle( const char* CabinetTitle );
 

hasSubEntities
Checks if this binder has any documents.
    DKBoolean hasSubEntities();
 

listSubEntities
Gets a list of documents. (The returned collection contains objects of type DKDocumentDefDD.)
    dkCollection* listSubEntities();
 

listSubEntityNames
Gets a list of document names for this binder.
    DKString* listSubEntityNames();
 

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