|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AttributeDescription
Description of a type attribute.
TypeManager
,
TypeDescription
Field Summary | |
---|---|
static java.lang.String |
MAXOCCURS_1
The maxOccurs setting if the attribute is not an array. |
static java.lang.String |
MAXOCCURS_UNBOUNDED
The maxOccurs setting if the attribute is an array. |
static java.lang.String |
MINOCCURS_0
The minOccurs setting if the attribute is not required. |
static java.lang.String |
MINOCCURS_1
The minOccurs setting if the attribute is required. |
static java.lang.String |
TYPE_ANY_SIMPLE_TYPE
Slot attribute data type - xs:anySimpleType. |
static java.lang.String |
TYPE_BOOLEAN
Slot attribute data type - xs:boolean. |
static java.lang.String |
TYPE_DATE
Slot attribute data type - xs:date. |
static java.lang.String |
TYPE_DATE_TIME
Slot attribute data type - xs:dateTime. |
static java.lang.String |
TYPE_DECIMAL
Slot attribute data type - xs:decimal. |
static java.lang.String |
TYPE_DOUBLE
Slot attribute data type - xs:double. |
static java.lang.String |
TYPE_DURATION
Slot attribute data type - xs:duration. |
static java.lang.String |
TYPE_NUMBER
Slot attribute data type - xs:integer. |
static java.lang.String |
TYPE_STRING
Slot attribute data type - xs:string. |
static java.lang.String |
TYPE_TIME
Slot attribute data type - xs:time. |
static java.lang.String |
TYPE_URL
Slot attribute data type - xs:anyURI. |
Method Summary | |
---|---|
java.lang.String |
getDataType()
Get the data type of the attribute. |
java.lang.Object |
getDefaultValue()
The default value for this attribute. |
java.lang.String |
getDescription()
Get the attribute description. |
java.lang.String |
getDisplayName()
Get the attribute's display name. |
java.lang.String[] |
getEnumValues()
Retrieves the enumeration values for string attribute. |
java.lang.String |
getLocalName()
Derive local part from complete name. |
java.lang.String |
getMaxOccurs()
|
java.lang.String |
getMinOccurs()
|
java.lang.String |
getName()
Get the attribute name. |
int |
getPrecision()
Get the precision for a "number" attribute. |
AttributeType |
getType()
Get the attribute type. |
java.lang.String |
getUnitLabel()
Return this slot's unit label. |
boolean |
isIndexed()
Checks whether a database index is defined for this attribute. |
boolean |
isPrefix()
Return whether this slot's unit label is a prefix or suffix value. |
boolean |
isReadOnly()
Checks whether the attribute value can be edited in an object. |
boolean |
isSystemDefined()
Tells whether the attribute is system defined or not |
boolean |
isUsed()
Checks if this attribute is being used in object instance. |
void |
setDefaultValue(java.lang.Object value)
Default value for object properties represented by this attribute. |
void |
setDescription(java.lang.String description)
Set the attribute description. |
void |
setEnumValues(java.lang.String[] enumValues)
Set the enumeration values for this attribute, in case it is of type string. |
void |
setIndexed(boolean indexed)
Sets whether a database index should be defined for this attribute. |
void |
setMaxOccurs(java.lang.String maxOccurs)
|
void |
setMinOccurs(java.lang.String minOccurs)
|
void |
setName(java.lang.String name)
Set the attribute name. |
void |
setPrecision(int precision)
Set the precision for a "number" attribute. |
void |
setPrefix(boolean prefix)
Specify whether this slot's unit label is to be a prefix or suffix value. |
void |
setReadOnly(boolean readOnly)
Sets whether the attribute value can be edited in an object |
void |
setUnitLabel(java.lang.String unitLabel)
Set this slot's unit label. |
java.lang.String |
toXML()
Return the XML representation of this attribute. |
Field Detail |
---|
static final java.lang.String MAXOCCURS_1
static final java.lang.String MAXOCCURS_UNBOUNDED
static final java.lang.String MINOCCURS_0
static final java.lang.String MINOCCURS_1
static final java.lang.String TYPE_BOOLEAN
static final java.lang.String TYPE_DATE_TIME
static final java.lang.String TYPE_DATE
static final java.lang.String TYPE_TIME
static final java.lang.String TYPE_DURATION
static final java.lang.String TYPE_ANY_SIMPLE_TYPE
static final java.lang.String TYPE_NUMBER
static final java.lang.String TYPE_STRING
static final java.lang.String TYPE_URL
static final java.lang.String TYPE_DOUBLE
static final java.lang.String TYPE_DECIMAL
Method Detail |
---|
AttributeType getType()
void setName(java.lang.String name) throws CSAppFrameworkException
name
- name in the form "{uri}local-name".
CSAppFrameworkException
java.lang.String getName() throws CSAppFrameworkException
CSAppFrameworkException
java.lang.String getLocalName() throws CSAppFrameworkException
CSAppFrameworkException
java.lang.String getDisplayName() throws CSAppFrameworkException
CSAppFrameworkException
void setDescription(java.lang.String description) throws CSAppFrameworkException
description
-
CSAppFrameworkException
java.lang.String getDescription() throws CSAppFrameworkException
CSAppFrameworkException
java.lang.String getDataType()
void setMinOccurs(java.lang.String minOccurs) throws CSAppFrameworkException
minOccurs
-
CSAppFrameworkException
java.lang.String getMinOccurs() throws CSAppFrameworkException
CSAppFrameworkException
void setMaxOccurs(java.lang.String maxOccurs) throws CSAppFrameworkException
maxOccurs
-
CSAppFrameworkException
java.lang.String getMaxOccurs() throws CSAppFrameworkException
CSAppFrameworkException
boolean isReadOnly() throws CSAppFrameworkException
true
if the attribute value is editable,
false
otherwise.
CSAppFrameworkException
void setReadOnly(boolean readOnly) throws CSAppFrameworkException
readOnly
-
CSAppFrameworkException
void setDefaultValue(java.lang.Object value) throws java.lang.Exception
value
-
java.lang.Exception
java.lang.Object getDefaultValue() throws CSAppFrameworkException
CSAppFrameworkException
void setEnumValues(java.lang.String[] enumValues) throws CSAppFrameworkException
enumValues
-
CSAppFrameworkException
java.lang.String[] getEnumValues() throws CSAppFrameworkException
CSAppFrameworkException
boolean isUsed() throws CSAppFrameworkException
CSAppFrameworkException
boolean isIndexed()
AttributeType.SLOT
can be indexed.
AttributeType.SLOT
and a database index is defined for itvoid setIndexed(boolean indexed)
AttributeType.SLOT
can be indexed.
indexed
- boolean isSystemDefined() throws CSAppFrameworkException
CSAppFrameworkException
void setUnitLabel(java.lang.String unitLabel)
unitLabel
- the unit labeljava.lang.String getUnitLabel()
void setPrefix(boolean prefix)
prefix
- true if the unit label is a prefix, false
for suffix.boolean isPrefix()
void setPrecision(int precision) throws CSAppFrameworkException
precision
- the precision
CSApFrameworkException
CSAppFrameworkException
int getPrecision() throws CSAppFrameworkException
CSApFrameworkException
CSAppFrameworkException
java.lang.String toXML() throws CSAppFrameworkException
CSApFrameworkException
CSAppFrameworkException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |