|
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
This class defines methods to access attribute information.
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId |
For details, see the class or interface |
Constructor Summary | |
dkAbstractAttrDef()
Constructs a new dkAbstractAttrDef class without owner datastore object. |
|
dkAbstractAttrDef(dkDatastore ds)
Constructs a new dkAbstractAttrDef 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. |
java.lang.String |
datastoreName()
Gets the name of this datastore object. |
java.lang.String |
datastoreType()
Gets the type for this datastore object |
void |
del()
Removes this attribute from the persistent part of the entity meta-data it belongs to. |
dkDatastore |
getDatastore()
Gets the reference to the owner datastore object |
java.lang.String |
getDescription()
Gets the attribute description |
dkEntityDef |
getEntity()
Gets the entity definition object that this attribute is belong to |
java.lang.String |
getEntityName()
Gets the parent entity name: index class, table, etc. |
int |
getMax()
Gets maximum value for this attribute |
int |
getMin()
Gets the minimum value for this attribute |
java.lang.String |
getName()
Gets this attribute name |
int |
getPrecision()
Gets precision value for this attribute |
java.lang.String |
getQualifiedName()
Gets this attribute qualified name. |
int |
getScale()
Gets scale value of this attribute if its type is decimal. |
int |
getSize()
Gets the display size for this attribute (applicable for String only) |
int |
getStringType()
Gets the string type value for this attribute |
short |
getType()
Gets type of this attribute |
boolean |
isNullable()
Checks if this attribute is nullable. |
boolean |
isQueryable()
Checks if this attribute is queryable. |
boolean |
isTextSearchable()
Checks if this attribute is text searchable. |
boolean |
isUpdatable()
Checks if this attribute is updatable. |
java.lang.String[] |
parsedQualifiedName(java.lang.String qualifiedName)
Parses the attribute qualified name. |
void |
setDatastore(dkDatastore ds)
Sets the reference to the owner datastore object |
void |
setDescription(java.lang.String desc)
Sets the attribute description |
void |
setEntity(dkEntityDef entityObj)
Sets the entity meta data object for this attribute |
void |
setEntityName(java.lang.String entityName)
Sets the parent entity name |
void |
setMax(int maxValue)
Sets the maximum value for this attribute |
void |
setMin(int minValue)
Sets the minimum value for this attribute |
void |
setName(java.lang.String attrName)
Sets name for this attribute |
void |
setNullable(boolean nullable)
Sets whether null value is allowed for this attribute. |
void |
setPrecision(int precision)
Sets precision value if this attribute type is decimal |
void |
setQualifiedName(java.lang.String qualifiedName)
Sets this attribute qualified name. |
void |
setQueryable(boolean queryable)
Sets the queryability of this attribute. |
void |
setScale(int scale)
Sets the scale value for this attribute if it's of type decimal |
void |
setSize(int displaySize)
Sets the display size for this attribute (applicable for String only) |
void |
setStringType(int stringType)
Sets the string type value for this attribute |
void |
setTextSearchable(boolean textSearchable)
Sets the text search ability of this attribute. |
void |
setType(short attrType)
Sets the type for this attribute |
void |
setUpdatable(boolean updatable)
Sets the updatability of this attribute. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public dkAbstractAttrDef()
public dkAbstractAttrDef(dkDatastore ds)
ds
- reference to owner datastore objectMethod Detail |
public void setDatastore(dkDatastore ds)
setDatastore
in interface dkAttrDef
com.ibm.mm.sdk.common.dkAttrDef
ds
- datastorepublic dkDatastore getDatastore()
getDatastore
in interface dkAttrDef
public dkEntityDef getEntity()
getEntity
in interface dkAttrDef
public void setEntity(dkEntityDef entityObj)
setEntity
in interface dkAttrDef
entityObj
- dkEntityDef objectpublic java.lang.String datastoreName() throws java.lang.Exception
datastoreName
in interface dkAttrDef
public java.lang.String datastoreType() throws DKException, java.lang.Exception
datastoreType
in interface dkAttrDef
public java.lang.String getEntityName()
getEntityName
in interface dkAttrDef
public void setEntityName(java.lang.String entityName)
setEntityName
in interface dkAttrDef
entityName
- parent entity namepublic java.lang.String getName()
getName
in interface dkAttrDef
public void setName(java.lang.String attrName)
setName
in interface dkAttrDef
attrName
- new name for this attributepublic java.lang.String getDescription()
getDescription
in interface dkAttrDef
public void setDescription(java.lang.String desc)
setDescription
in interface dkAttrDef
desc
- attribute descriptionpublic short getType()
getType
in interface dkAttrDef
public void setType(short attrType)
setType
in interface dkAttrDef
attrType
- new attribute typepublic int getSize()
getSize
in interface dkAttrDef
public void setSize(int displaySize)
setSize
in interface dkAttrDef
displaySize
- new display size to be set.public boolean isNullable()
isNullable
in interface dkAttrDef
public void setNullable(boolean nullable)
setNullable
in interface dkAttrDef
nullable
- true if null value is allowed, false otherwisepublic int getPrecision()
getPrecision
in interface dkAttrDef
public void setPrecision(int precision)
setPrecision
in interface dkAttrDef
precision
- maximum value for short or longpublic int getScale()
getScale
in interface dkAttrDef
public void setScale(int scale)
setScale
in interface dkAttrDef
scale
- the minimum value for short/longpublic int getMax()
getMax
in interface dkAttrDef
public void setMax(int maxValue)
setMax
in interface dkAttrDef
maxValue
- the valid upper value for this attributepublic int getMin()
getMin
in interface dkAttrDef
public void setMin(int minValue)
setMin
in interface dkAttrDef
minValue
- the valid lower bound for this attributepublic int getStringType()
getStringType
in interface dkAttrDef
public void setStringType(int stringType)
setStringType
in interface dkAttrDef
stringType
- the string type for this attributepublic boolean isUpdatable()
isUpdatable
in interface dkAttrDef
public void setUpdatable(boolean updatable)
setUpdatable
in interface dkAttrDef
updatable
- true if updatable value, false otherwisepublic boolean isQueryable()
isQueryable
in interface dkAttrDef
public void setQueryable(boolean queryable)
setQueryable
in interface dkAttrDef
queryable
- true if queryable value, false otherwisepublic void add() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
add
in interface dkAttrDef
public void del() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
del
in interface dkAttrDef
public boolean isTextSearchable()
isTextSearchable
in interface dkAttrDef
public void setTextSearchable(boolean textSearchable)
setTextSearchable
in interface dkAttrDef
textSearchable
- true if text searchable value, false otherwisepublic java.lang.String getQualifiedName() throws DKException, java.lang.Exception
getQualifiedName
in interface dkAttrDef
public void setQualifiedName(java.lang.String qualifiedName) throws DKException, java.lang.Exception
setQualifiedName
in interface dkAttrDef
public java.lang.String[] parsedQualifiedName(java.lang.String qualifiedName) throws DKException, java.lang.Exception
parsedQualifiedName
in interface dkAttrDef
qualifiedName
- the attribute qualified name
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |