com.softwareag.centrasite.api.csom.attribute
Interface SimpleAttribute

All Superinterfaces:
CentraSiteObjectAttribute
All Known Subinterfaces:
CSOComputedAttribute

public interface SimpleAttribute
extends CentraSiteObjectAttribute

SimpleAttribute interface represents the simple attributes of a CentraSiteObject. This interface defines the methods that operate on a simple attribute.


Field Summary
 
Fields inherited from interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
TYPE_CLASSIFICATION, TYPE_COMMON, TYPE_COMPUTED, TYPE_FILE, TYPE_RELATIONSHIP, TYPE_REPORT_ATTRIBUTE, TYPE_SIMPLE
 
Method Summary
 java.lang.String[] getEnumValues()
          Get enumerated values (i.e., list of possible values) for an attribute of "string" data type.
 int getPrecision()
          Gets the precision value for an attribute of "number" data type.
 java.lang.String getUnitLabel()
          Returns the slot's unit label.
 boolean isPrefix()
          Returns if the slot's unit label is a prefix or suffix value.
 void setEnumValues(java.lang.String[] validValues)
          Sets enumeration values (i.e., list of possible values) for an attribute of "string" data type.
 void setPrecision(int precision)
          Sets the precision for an attribute of "number" data type.
 
Methods inherited from interface com.softwareag.centrasite.api.csom.attribute.CentraSiteObjectAttribute
getCentraSiteObjectType, getDataType, getDefaultValue, getDescription, getDescription, getDisplayName, getDisplayName, getName, getQName, getType, isMultiValued, isReadOnly, isRequired
 

Method Detail

getEnumValues

java.lang.String[] getEnumValues()
Get enumerated values (i.e., list of possible values) for an attribute of "string" data type.

Returns:
list of possible values for a "string" attribute

setEnumValues

void setEnumValues(java.lang.String[] validValues)
Sets enumeration values (i.e., list of possible values) for an attribute of "string" data type.

Parameters:
validValues - list of pre-defined enumeration values for a "string" attribute

setPrecision

void setPrecision(int precision)
                  throws CLLException
Sets the precision for an attribute of "number" data type.

Parameters:
precision - number of decimal positions that are to be shown when the "number" attribute is displayed in a user interface
Throws:
CLLException

getPrecision

int getPrecision()
                 throws CLLException
Gets the precision value for an attribute of "number" data type.

Returns:
gets the precision for a "number" attribute
Throws:
CLLException - if CLL fails to get the precision for a "number" attribute

getUnitLabel

java.lang.String getUnitLabel()
Returns the slot's unit label.

Returns:
slot unit label. This label may be null

isPrefix

boolean isPrefix()
Returns if the slot's unit label is a prefix or suffix value.

Returns:
true if the slot's unit label is a prefix, and false if it is a suffix