Index

DKDocumentDefDD

Purpose:

The DKDocumentDefDD class defines methods to get Domino.Doc Document information. Access to these objects is through the DKBinderDefDD, listSubEntities method. Domino.Doc binders have documents which contain attributes. This class also performs the following functions:

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

Class summary:

class DKDocumentDefDD : public DKEntityDefDD
{
  public:
    DKDocumentDefDD();
    DKDocumentDefDD(dkDatastore* ds);
 
    ~DKDocumentDefDD();
 
    virtual DKString getBinderTitle();
    virtual DKString getCabinetTitle();
    virtual DKString getCreateDate();
    virtual DKString getDocType();
    virtual DKString getFileExtension();
    virtual DKString  getFileName();
    virtual DKAttrProfileDefDD* getProfile();
    dkAttrDef*     createAttr();
    dkAttrDef*     getAttr(const char* attrName);
    DKBoolean      isSearchable();
    dkCollection*  listAttrs();
    DKString*      listAttrNames(long& arraySize);
    DKBoolean      hasSubEntities();
    DKString toString();
};

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 owner datastore object.
    DKDocumentDefDD();
    DKDocumentDefDD(dkDatastore* ds);
 
    ~DKDocumentDefDD();
 

Member functions

getBinderTitle
Gets Domino.Doc parent binder title for this document.
    virtual DKString getBinderTitle();
 

getCabinetTitle
Gets Domino.Doc parent cabinet title for this document.
    virtual DKString getCabinetTitle();
 

getCreateDate
Gets the creation date of this document.
    virtual DKString getCreateDate();
 

getDocType
Gets the document type for this document.
    virtual DKString getDocType();
 

getFileExtension
Gets the file extension of the current version of this document.
    virtual DKString getFileExtension();
 

getFileName
Gets the file name of the current version of this document.
    virtual DKString  getFileName();
 

getProfile
Gets a pointer to the profile for this document.
    virtual DKAttrProfileDefDD* getProfile();
 

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

getAttr
Retrieves an attribute object for a given attribute name.

Parameters

attrName
The name of the attribute to be retrieved. This can be:
  • One of the field names predefined in DKConstantDD, like DK_DD_DOC_TYPE, or DK_DD_TITLE.
  • One of the field names or keyword names held in a DKAttrProfileDefDD.

    dkAttrDef* getAttr(const char* attrName);

isSearchable
Checks to see if this entity can be searched or not.
    DKBoolean isSearchable();
 

listAttrs
Gets a list of DKAttrDefDD objects for this document.
    dkCollection*  listAttrs();
 

listAttrNames
Gets a list of attribute names. listAttrNames calls listAttrs() and then extracts predefined attribute names, field names, and keyword names.
    DKString* listAttrNames(long& arraySize);
 

hasSubEntities
hasSubEntities always returns false for a Domino.Doc document.
    DKBoolean hasSubEntities();
 

toString
Gets a string containing attributes of this document. The string is suitable for debugging purposes.
    DKString toString();
 

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