Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAttrKeywordDefDD

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractAttrDef
        |
        +--com.ibm.mm.sdk.common.DKAttrDefDD
              |
              +--com.ibm.mm.sdk.common.DKAttrKeywordDefDD
All Implemented Interfaces:
dkAttrDef, DKConstant, DKConstantDD, DKMessageId, DKMessageIdDD, java.io.Serializable

public class DKAttrKeywordDefDD
extends DKAttrDefDD
implements DKConstantDD, DKMessageIdDD

This class corresponds to a IKeyword object of Domino.Doc. It extends DKAttrDefDD.

Keywords are used as a pre-defined valid value for a field. For example, the day_of_week field could have 7 keywords associated with it (Monday, Tuesday, etc.)

Access to keywords is gained through a field.

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

See Also:
DKAttrFieldDefDD, DKAttrProfileDefDD, DKAttrDefDD, 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
DKAttrKeywordDefDD()
          Construct a new empty object.
DKAttrKeywordDefDD(dkDatastore ds)
          Construct an object aware of it's datastore
DKAttrKeywordDefDD(dkDatastore ds, java.lang.String keywordName, java.lang.String value, DKAttrFieldDefDD parentField, int libraryHandle)
          Construct a Domino.Doc keyword object
 
Method Summary
 DKAttrFieldDefDD getField()
          Get parent field object
 boolean getIsValid()
          Return validity flag
 int getLibraryHandle()
          Return library handle, used by JNI code to gain access to Domino.Doc API
 void setField(DKAttrFieldDefDD field)
          Set parent field object
 void setIsValid(boolean isValid)
          set validity flag
 void setLibraryHandle(int libraryHandle)
          set library handle
 java.lang.String toString()
          Get a string representation of this class
 
Methods inherited from class com.ibm.mm.sdk.common.DKAttrDefDD
add, compareTo, del, getDDType, getValue, setDDType, setValue
 
Methods inherited from class com.ibm.mm.sdk.common.dkAbstractAttrDef
datastoreName, datastoreType, getDatastore, getDescription, getEntity, getEntityName, getMax, getMin, getName, getPrecision, getQualifiedName, getScale, getSize, getStringType, getType, isNullable, isQueryable, isTextSearchable, isUpdatable, parsedQualifiedName, setDatastore, setDescription, setEntity, setEntityName, setMax, setMin, setName, setNullable, setPrecision, setQualifiedName, setQueryable, setScale, setSize, setStringType, setTextSearchable, setType, setUpdatable
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.ibm.mm.sdk.common.dkAttrDef
datastoreName, datastoreType, getDatastore, getDescription, getEntity, getEntityName, getMax, getMin, getName, getPrecision, getQualifiedName, getScale, getSize, getStringType, getType, isNullable, isQueryable, isTextSearchable, isUpdatable, parsedQualifiedName, setDatastore, setDescription, setEntity, setEntityName, setMax, setMin, setName, setNullable, setPrecision, setQualifiedName, setQueryable, setScale, setSize, setStringType, setTextSearchable, setType, setUpdatable
 

Constructor Detail

DKAttrKeywordDefDD

public DKAttrKeywordDefDD()
Construct a new empty object.

DKAttrKeywordDefDD

public DKAttrKeywordDefDD(dkDatastore ds)
Construct an object aware of it's datastore

DKAttrKeywordDefDD

public DKAttrKeywordDefDD(dkDatastore ds,
                          java.lang.String keywordName,
                          java.lang.String value,
                          DKAttrFieldDefDD parentField,
                          int libraryHandle)
Construct a Domino.Doc keyword object
Method Detail

getField

public DKAttrFieldDefDD getField()
Get parent field object

setField

public void setField(DKAttrFieldDefDD field)
Set parent field object

getIsValid

public boolean getIsValid()
Return validity flag

setIsValid

public void setIsValid(boolean isValid)
set validity flag

getLibraryHandle

public int getLibraryHandle()
Return library handle, used by JNI code to gain access to Domino.Doc API

setLibraryHandle

public void setLibraryHandle(int libraryHandle)
set library handle

toString

public java.lang.String toString()
Description copied from class: DKAttrDefDD
Get a string representation of this class
Overrides:
toString in class DKAttrDefDD
Following copied from class: com.ibm.mm.sdk.common.DKAttrDefDD
Returns:
a string suitable for debugging purposes

EIP Java APIs

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