Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKFieldDefOD

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

public class DKFieldDefOD
extends dkAbstractAttrDef
implements DKConstantOD, DKMessageIdOD, java.io.Serializable

This class defines methods to access attribute information as well as to create and delete attributes

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKConstantOD
    For details, see the class or interface
 
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.DKMessageIdOD
DK_OD_MSG_INIT_FAILED, DK_OD_MSG_INVALID_API, DK_OD_MSG_INVALID_CHOICE, DK_OD_MSG_INVALID_DATE, DK_OD_MSG_INVALID_DECIMAL, DK_OD_MSG_INVALID_INTEGER, DK_OD_MSG_INVALID_OPERATOR, DK_OD_MSG_INVALID_RANGE, DK_OD_MSG_INVALID_SEARCH, DK_OD_MSG_INVALID_SEGMENT_NUM, DK_OD_MSG_MSGID_NOT_FOUND, DK_OD_MSG_NO_VALUES_SPECIFIED, DK_OD_MSG_ONLY_ONE_VALUE_GIVEN, DK_OD_MSG_SERVER_TIMEOUT, DK_OD_MSG_UNDEFINED, DK_OD_MSG_UNKNOWN_ERROR, DK_OD_MSG_VALUE_NOT_SPECIFIED
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Constructor Summary
DKFieldDefOD()
          Creates a DKFieldDefOD object
DKFieldDefOD(dkDatastore ds)
          Creates a DKFieldDefOD 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.
 
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, toString, wait, wait, wait
 

Constructor Detail

DKFieldDefOD

public DKFieldDefOD()
Creates a DKFieldDefOD object

DKFieldDefOD

public DKFieldDefOD(dkDatastore ds)
Creates a DKFieldDefOD object
Parameters:
ds - a datastore object
Method Detail

add

public void add()
         throws DKException,
                java.lang.Exception
Adds this attribute to become a persistent part of the entity meta-data it belongs to.
Overrides:
add in class dkAbstractAttrDef
Throws:
DKException - if error detected
java.lang.Exception - if error detected

del

public void del()
         throws DKException,
                java.lang.Exception
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.
Overrides:
del in class dkAbstractAttrDef
Throws:
DKException - if error detected
java.lang.Exception - if error detected

EIP Java APIs

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