Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKAttrDefDD

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

public class DKAttrDefDD
extends dkAbstractAttrDef
implements dkAttrDef, DKConstantDD, DKMessageId, java.io.Serializable

This class represents a basic domino.Doc attribute. Attributes in domino.doc can be:

See Also:
DKAttrProfileDefDD, DKAttrFieldDefDD, DKAttrKeywordDefDD, 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.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKAttrDefDD()
          Default constructor
DKAttrDefDD(dkDatastore ds)
          Default constructor taking a datastore ref
DKAttrDefDD(dkDatastore ds, dkEntityDef parentEntity, java.lang.String parentEntityName, java.lang.String attributeName, short attrId, short attrType, short minValue, short maxValue, boolean queryable, boolean nullable, int stringType, java.lang.String value)
          Constructor suitable for use by an entity
 
Method Summary
 void add()
          Not supported in Domino.Doc
 int compareTo(DKAttrDefDD anotherAttrDef)
          Compare enity names strings of two attrDef objects.
 void del()
          Not supported in Domino.Doc
 short getDDType()
          Returns the Domino.Doc Attribute type.
 java.lang.String getValue()
          Get the value associated with this attribute's name.
 void setDDType(short ddType)
          Sets the Domino.Doc attribute type of this object.
 void setValue(java.lang.String value)
          Set a value for this attribute
 java.lang.String toString()
          Get a string representation of this class
 
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

DKAttrDefDD

public DKAttrDefDD()
Default constructor

DKAttrDefDD

public DKAttrDefDD(dkDatastore ds)
Default constructor taking a datastore ref

DKAttrDefDD

public DKAttrDefDD(dkDatastore ds,
                   dkEntityDef parentEntity,
                   java.lang.String parentEntityName,
                   java.lang.String attributeName,
                   short attrId,
                   short attrType,
                   short minValue,
                   short maxValue,
                   boolean queryable,
                   boolean nullable,
                   int stringType,
                   java.lang.String value)
Constructor suitable for use by an entity
Method Detail

getValue

public java.lang.String getValue()
Get the value associated with this attribute's name.
Returns:
a value string, which may be empty if there is no value.

setValue

public void setValue(java.lang.String value)
Set a value for this attribute
Parameters:
a - String.

getDDType

public short getDDType()
Returns the Domino.Doc Attribute type. It will be one of the following:
DK_DD_ATTR
This object is a document attribute (e.g., document type, title, etc.)
DK_DD_PROFILE
This object is a DKAttrProfileDef
DK_DD_FIELD
This object is a DKAttrFieldDef
DK_DD_KEYWORD
This object is a DKAttrKeywordDef

setDDType

public void setDDType(short ddType)
               throws DKException
Sets the Domino.Doc attribute type of this object.
Returns:
DK_DD_ATTR
This object is a document attribute (e.g., document type, title, etc.)
DK_DD_PROFILE
This object is a DKAttrProfileDef
DK_DD_FIELD
This object is a DKAttrFieldDef
DK_DD_KEYWORD
This object is a DKAttrKeywordDef
Throws:
DKException - (DKUsageError) if parameter is not valid

compareTo

public int compareTo(DKAttrDefDD anotherAttrDef)
Compare enity names strings of two attrDef objects.
Parameters:
anotherAttrDef - - the Attr def whose name will be compared.
Returns:
the value 0 if the argument obj name is equal to this obj name; a value less than 0 if this obj name less than the argument's name; and a value greater than 0 if this obj name is greater than the argument's name.

toString

public java.lang.String toString()
Get a string representation of this class
Overrides:
toString in class java.lang.Object
Returns:
a string suitable for debugging purposes

add

public void add()
         throws DKException,
                java.lang.Exception
Not supported in Domino.Doc
Specified by:
add in interface dkAttrDef
Overrides:
add in class dkAbstractAttrDef
Throws:
DKException - DKUsageError, not implemented

del

public void del()
         throws DKException,
                java.lang.Exception
Not supported in Domino.Doc
Specified by:
del in interface dkAttrDef
Overrides:
del in class dkAbstractAttrDef
Throws:
DKException - DKUsageError, not implemented

EIP Java APIs

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