|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This class defines methods to access attribute information as well as to create and delete attributes
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)
Gets the attribute qualified name path. |
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 type of this attribute |
void |
setUpdatable(boolean updatable)
Sets the updatability of this attribute. |
Method Detail |
public void setDatastore(dkDatastore ds)
ds
- datastorepublic dkDatastore getDatastore()
public dkEntityDef getEntity()
public void setEntity(dkEntityDef entityObj)
entityObj
- dkEntityDef objectpublic java.lang.String datastoreName() throws java.lang.Exception
public java.lang.String datastoreType() throws DKException, java.lang.Exception
public java.lang.String getEntityName()
public void setEntityName(java.lang.String entityName)
entityName
- parent entity namepublic java.lang.String getName()
public void setName(java.lang.String attrName)
attrName
- new name for this attributepublic java.lang.String getDescription()
public void setDescription(java.lang.String desc)
desc
- attribute descriptionpublic short getType()
public void setType(short attrType)
attrType
- attribute typepublic int getSize()
public void setSize(int displaySize)
displaySize
- new display size to be set.public boolean isNullable()
public void setNullable(boolean nullable)
nullable
- true if null value is allowed, false otherwisepublic int getPrecision()
public void setPrecision(int precision)
precision
- maximum value for short or longpublic int getScale()
public void setScale(int scale)
scale
- the minimum value for short/longpublic int getMax()
public void setMax(int maxValue)
maxValue
- the valid upper value for this attributepublic int getMin()
public void setMin(int minValue)
minValue
- the valid lower bound for this attributepublic int getStringType()
public void setStringType(int stringType)
stringType
- the string type for this attributepublic boolean isUpdatable()
public void setUpdatable(boolean updatable)
updatable
- true if updatable value, false otherwisepublic boolean isQueryable()
public void setQueryable(boolean queryable)
queryable
- true if queryable value, false otherwisepublic void add() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public void del() throws DKException, java.lang.Exception
Note:DKUsageError exception thrown if method is not implemented
public boolean isTextSearchable()
public void setTextSearchable(boolean textSearchable)
textSearchable
- true if text searchable value, false otherwisepublic java.lang.String getQualifiedName() throws DKException, java.lang.Exception
public void setQualifiedName(java.lang.String qualifiedName) throws DKException, java.lang.Exception
qualifiedName
- qualified name of this attributepublic java.lang.String[] parsedQualifiedName(java.lang.String qualifiedName) throws DKException, java.lang.Exception
qualifiedName
- the attribute qualified name
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |