Index

DKAttrFieldDefDD

Purpose:

The DKAttrFieldDefDD class corresponds to a Domino.Doc IField object and extends DKAttrDefDD. You can access fields through a profile. The Domino.Doc administrator defines fields--the type a user sees on index cards. For example, an Appointment Schedule document might have a "Day of Week" field. If the field has keywords, you can access them through the IField Object.

Any method that Domino.Doc does not support in this release will throw a DKMSG_NOTIMP DKUsageError. For more information, see DKAttrKeywordDefDD, DKAttrProfileDefDD, and DKAttrDefDD.

Class summary:

class DKAttrFieldDefDD : public DKAttrDefDD
{
public:
  virtual ~DKAttrFieldDefDD();
 
  DKAttrFieldDefDD();
  DKAttrFieldDefDD(dkDatastore* ds);
  DKAttrFieldDefDD(dkDatastore*     ds
                  , DKString       fieldName
                  , DKString       value
                  , DKAttrProfileDefDD*  profile
                  , int          libraryHandle);
 
  DKAttrFieldDefDD( DKAttrFieldDefDD* aKeyword );
  DKAttrFieldDefDD( DKAttrFieldDefDD& aKeyword );
  DKAttrFieldDefDD& operator= ( DKAttrFieldDefDD* aField );
  DKAttrFieldDefDD& operator= ( DKAttrFieldDefDD& aField );
  long                getNbrKeywords();
  dkCollection*       getKeywords();
  void                setKeywords(dkCollection* keywords);
  void                setParent(DKAttrProfileDefDD* profile);
  DKAttrProfileDefDD* getParent();
 

Members:

Constructors and destructor
Constructs a Domino.Doc field object.
  virtual ~DKAttrFieldDefDD();
  DKAttrFieldDefDD();
  DKAttrFieldDefDD(dkDatastore* ds);
  DKAttrFieldDefDD(dkDatastore*     ds
                  , DKString       fieldName
                  , DKString       value
                  , DKAttrProfileDefDD*  profile
                  , int          libraryHandle);
  DKAttrFieldDefDD( DKAttrFieldDefDD* aKeyword );
  DKAttrFieldDefDD( DKAttrFieldDefDD& aKeyword );  
 

Member functions

operator=
Copies the input field to this object.
  DKAttrFieldDefDD& operator= ( DKAttrFieldDefDD* aField );
 

operator=
Copies the input field to this object.
  DKAttrFieldDefDD& operator= ( DKAttrFieldDefDD& aField );
 

getNbrKeywords
Returns the number of Domino.Doc keywords associated with this Domino.Doc profile field attribute.
  long getNbrKeywords();
 

getKeywords
Gets a collection of keywords. (Returns a collection of DKAttrKeywordDefDD objects.)
  dkCollection* getKeywords();
 

setKeywords
Sets keywords. The collection should contain DKANY objects, each of which contains a pointer to a DKAttr KeywordDefDD.
  void setKeywords(dkCollection* keywords);
 

setParent
Sets the profile which contains this field.
  void setParent(DKAttrProfileDefDD* profile);
 

getParent
Gets the profile which contains this field.
  DKAttrProfileDefDD* getParent();
 

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