Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKFieldDefDES

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.dkAbstractAttrDef
        |
        +--com.ibm.mm.sdk.common.DKFieldDefDES
All Implemented Interfaces:
dkAttrDef, DKConstant, DKConstantDES, DKMessageId, java.io.Serializable

public class DKFieldDefDES
extends dkAbstractAttrDef
implements java.io.Serializable, DKConstantDES

DKFieldDefDES defines DES attributes.

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantDES
DK_DES_APPID_HANDLE, DK_DES_APPINFO_HANDLE, DK_DES_BROKER_HANDLE, DK_DES_CMBROOT, DK_DES_DATASOURCE, DK_DES_DLL_NAME, DK_DES_DSTYPE, DK_DES_GQL_QL_TYPE, DK_DES_INIFILE, DK_DES_ITEMID_SEPARATOR, DK_DES_PORT, DK_DES_PROPERTY_DISPNAME, DK_DES_PROPERTY_HELPTEXT, DK_DES_PROPERTY_LANGUAGE, DK_DES_PROPERTY_RETRIEVABLE, DK_DES_PROPERTY_SEARCHABLE, DK_DES_PROPERTY_SEARCHOPERATOR, DK_DES_PROPERTY_VALUECOUNT, DK_DES_REPOSITORIES_HANDLE, DK_DES_RMIREF_HANDLE, DK_DES_SESSION_HANDLE, DK_FILESYSTEM_ENTITY, DK_NOTES_ENTITY, DK_NOTESPUMP_ENTITY, DK_WEB_ENTITY
 
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
DKFieldDefDES()
          Default constructor
DKFieldDefDES(dkDatastore ds)
          Constructs a new DKFieldDefDES class with owner datastore object.
 
Method Summary
 void add()
          Adds this attribute to become a persistent part of the entity meta-data it belongs to.
 void del()
          Removes this attribute from the persistent part of the entity meta-data it belongs to.
 java.lang.String getDisplayName()
          Get the display name of the database.
 java.lang.String getHelpText()
          Get the help text
 java.lang.String getLanguage()
          Get the language.
 int getNumVals()
          Get the number of values
 int getSchema()
          Get the schema
 boolean isTextSearchable()
          Checks if this attribute is text searchable.
 boolean isUpdatable()
          Retuen false since DES attrs are NOT updatable
 void setDisplayName(java.lang.String dispName)
          Set the display name of the database.
 void setHelpText(java.lang.String txt)
          Set the help text
 void setLanguage(java.lang.String lang)
          Set the language.
 void setNumVals(int num)
          Set the number of values
 void setSchema(int schema)
          Set the schema
 void setTextSearchable(boolean textSearchable)
          Sets this attribute to be text searchable
 
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, parsedQualifiedName, setDatastore, setDescription, setEntity, setEntityName, setMax, setMin, setName, setNullable, setPrecision, setQualifiedName, setQueryable, setScale, setSize, setStringType, setType, setUpdatable
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKFieldDefDES

public DKFieldDefDES()
Default constructor

DKFieldDefDES

public DKFieldDefDES(dkDatastore ds)
              throws DKException,
                     java.lang.Exception
Constructs a new DKFieldDefDES class with owner datastore object.
Parameters:
ds - reference to owner datastore object
Method Detail

add

public void add()
         throws DKException,
                java.lang.Exception
Description copied from class: dkAbstractAttrDef
Adds this attribute to become a persistent part of the entity meta-data it belongs to.

Note:DKUsageError exception thrown if method is not implemented

Overrides:
add in class dkAbstractAttrDef

del

public void del()
         throws DKException,
                java.lang.Exception
Description copied from class: dkAbstractAttrDef
Removes this attribute from the persistent part of the entity meta-data it belongs to. The in memory copy of this attribute does not change. Sub class needs to implement this method.

Note:DKUsageError exception thrown if method is not implemented

Overrides:
del in class dkAbstractAttrDef

getDisplayName

public java.lang.String getDisplayName()
Get the display name of the database.
Returns:
display name

setDisplayName

public void setDisplayName(java.lang.String dispName)
Set the display name of the database.
Parameters:
display - name

getLanguage

public java.lang.String getLanguage()
Get the language.
Returns:
language

setLanguage

public void setLanguage(java.lang.String lang)
Set the language.
Parameters:
language -  

getHelpText

public java.lang.String getHelpText()
Get the help text
Returns:
help text

setHelpText

public void setHelpText(java.lang.String txt)
Set the help text
Parameters:
help - text

getSchema

public int getSchema()
Get the schema
Returns:
schema

setSchema

public void setSchema(int schema)
Set the schema
Parameters:
schema -  

getNumVals

public int getNumVals()
Get the number of values
Returns:
number of values

setNumVals

public void setNumVals(int num)
Set the number of values
Parameters:
number - of values

isUpdatable

public boolean isUpdatable()
Retuen false since DES attrs are NOT updatable
Overrides:
isUpdatable in class dkAbstractAttrDef
Parameters:
void -  

isTextSearchable

public boolean isTextSearchable()
Checks if this attribute is text searchable.
Overrides:
isTextSearchable in class dkAbstractAttrDef
Returns:
true if this attribute is text searchable, false otherwise

setTextSearchable

public void setTextSearchable(boolean textSearchable)
Sets this attribute to be text searchable
Overrides:
setTextSearchable in class dkAbstractAttrDef
Parameters:
textSearchable - is true if the attribute is text searchable

EIP Java APIs

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