|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.dkAbstractAttrDef | +--com.ibm.mm.sdk.common.DKAttrDefDD | +--com.ibm.mm.sdk.common.DKAttrFieldDefDD
This class corresponds to a IField object of Domino.Doc. It extends DKAttrDefDD.
Access to fields is gained through a profile. Fields are defined by the Domino.Doc administrator. They are the fields a user sees on index cards. For example, an Appointment Schedule document might have a "Day of Week" field.
If a field has keywords, you access them through an object of this type.
Any method not supported by Domino.Doc in this release will throw a DKMSG_NOTIMP DKUsageError (... not implemented).
DKAttrKeywordDefDD
,
DKAttrProfileDefDD
,
DKAttrDefDD
, Serialized FormFields 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 | |
DKAttrFieldDefDD()
Constructs a new empty object. |
|
DKAttrFieldDefDD(dkDatastore ds)
Construct an object aware of it's datastore |
|
DKAttrFieldDefDD(dkDatastore ds,
java.lang.String fieldName,
java.lang.String value,
DKAttrProfileDefDD profile,
int libraryHandle)
Construct a Domino.Doc field object |
Method Summary | |
boolean |
getIsValid()
Return validity flag |
dkCollection |
getKeywords()
Get collection of keywords |
int |
getLibraryHandle()
Get library handle. |
long |
getNbrKeywords()
Returns the number of Domino.Doc keywords associated with this Domino.Doc profile field attribute. |
DKAttrProfileDefDD |
getProfile()
get parent profile object |
void |
setIsValid(boolean isValid)
set validity flag |
void |
setKeywords(dkCollection keywords)
Set keywords |
void |
setLibraryHandle(int libraryHandle)
set library handle |
void |
setProfile(DKAttrProfileDefDD profile)
set parent profile object |
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 |
public DKAttrFieldDefDD()
public DKAttrFieldDefDD(dkDatastore ds)
public DKAttrFieldDefDD(dkDatastore ds, java.lang.String fieldName, java.lang.String value, DKAttrProfileDefDD profile, int libraryHandle) throws DKException, java.lang.Exception
Method Detail |
public long getNbrKeywords()
DKAttrKeywordDefDD
public dkCollection getKeywords()
DKAttrKeywordDefDD
public void setKeywords(dkCollection keywords)
keywords
- is a collection of DKAttrKeywordDefDD objects.public DKAttrProfileDefDD getProfile()
public void setProfile(DKAttrProfileDefDD profile)
public boolean getIsValid()
public void setIsValid(boolean isValid)
public int getLibraryHandle()
public void setLibraryHandle(int libraryHandle)
public java.lang.String toString()
toString
in class DKAttrDefDD
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |