|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.softwareag.centrasite.appl.framework.types.impl.AttributeDescriptionImpl
public class AttributeDescriptionImpl
Field Summary |
---|
Fields inherited from interface com.softwareag.centrasite.appl.framework.types.AttributeDescription |
---|
MAXOCCURS_1, MAXOCCURS_UNBOUNDED, MINOCCURS_0, MINOCCURS_1, TYPE_ANY_SIMPLE_TYPE, TYPE_BOOLEAN, TYPE_DATE, TYPE_DATE_TIME, TYPE_DECIMAL, TYPE_DOUBLE, TYPE_DURATION, TYPE_NUMBER, TYPE_STRING, TYPE_TIME, TYPE_URL |
Constructor Summary | |
---|---|
AttributeDescriptionImpl(com.centrasite.jaxr.type.CentraSiteAttribute csAttribute)
Creates an AttributeDescription using the provided CentraSiteAttribute |
Method Summary | |
---|---|
com.centrasite.jaxr.type.CentraSiteAttribute |
getCentraSiteAttribute()
|
com.centrasite.jaxr.type.CentraSiteAttribute |
getCsAttribute()
Returns the CentraSiteAttribute object associated with the AttributeDescription |
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 |
setCsAttribute(com.centrasite.jaxr.type.CentraSiteAttribute csAttribute)
Sets the CentraSiteAttribute object associated with the AttributeDescription |
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. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AttributeDescriptionImpl(com.centrasite.jaxr.type.CentraSiteAttribute csAttribute)
csAttribute
- Method Detail |
---|
public com.centrasite.jaxr.type.CentraSiteAttribute getCsAttribute()
public void setCsAttribute(com.centrasite.jaxr.type.CentraSiteAttribute csAttribute)
public java.lang.String getDataType()
getDataType
in interface AttributeDescription
public java.lang.Object getDefaultValue() throws CSAppFrameworkException
getDefaultValue
in interface AttributeDescription
CSAppFrameworkException
public java.lang.String getDescription() throws CSAppFrameworkException
getDescription
in interface AttributeDescription
CSAppFrameworkException
public java.lang.String[] getEnumValues() throws CSAppFrameworkException
getEnumValues
in interface AttributeDescription
CSAppFrameworkException
public java.lang.String getLocalName() throws CSAppFrameworkException
getLocalName
in interface AttributeDescription
CSAppFrameworkException
public java.lang.String getMaxOccurs() throws CSAppFrameworkException
getMaxOccurs
in interface AttributeDescription
CSAppFrameworkException
public java.lang.String getMinOccurs() throws CSAppFrameworkException
getMinOccurs
in interface AttributeDescription
CSAppFrameworkException
public java.lang.String getName() throws CSAppFrameworkException
getName
in interface AttributeDescription
CSAppFrameworkException
public java.lang.String getDisplayName() throws CSAppFrameworkException
getDisplayName
in interface AttributeDescription
CSAppFrameworkException
public boolean isReadOnly() throws CSAppFrameworkException
isReadOnly
in interface AttributeDescription
true
if the attribute value is editable,
false
otherwise.
CSAppFrameworkException
public boolean isUsed() throws CSAppFrameworkException
isUsed
in interface AttributeDescription
CSAppFrameworkException
public void setDefaultValue(java.lang.Object value) throws java.lang.Exception
setDefaultValue
in interface AttributeDescription
java.lang.Exception
public void setDescription(java.lang.String description) throws CSAppFrameworkException
setDescription
in interface AttributeDescription
CSAppFrameworkException
public void setEnumValues(java.lang.String[] enumValues) throws CSAppFrameworkException
AttributeDescription
setEnumValues
in interface AttributeDescription
CSAppFrameworkException
public void setMaxOccurs(java.lang.String maxOccurs) throws CSAppFrameworkException
setMaxOccurs
in interface AttributeDescription
CSAppFrameworkException
public void setMinOccurs(java.lang.String minOccurs) throws CSAppFrameworkException
setMinOccurs
in interface AttributeDescription
CSAppFrameworkException
public void setName(java.lang.String name) throws CSAppFrameworkException
setName
in interface AttributeDescription
name
- name in the form "{uri}local-name".
CSAppFrameworkException
public void setReadOnly(boolean readOnly) throws CSAppFrameworkException
setReadOnly
in interface AttributeDescription
CSAppFrameworkException
public AttributeType getType()
getType
in interface AttributeDescription
public boolean isIndexed()
AttributeType.SLOT
can be indexed.
isIndexed
in interface AttributeDescription
AttributeType.SLOT
and a database index is defined for itpublic void setIndexed(boolean indexed)
AttributeType.SLOT
can be indexed.
setIndexed
in interface AttributeDescription
public com.centrasite.jaxr.type.CentraSiteAttribute getCentraSiteAttribute()
public int getPrecision() throws CSAppFrameworkException
AttributeDescription
getPrecision
in interface AttributeDescription
CSAppFrameworkException
public java.lang.String getUnitLabel()
AttributeDescription
getUnitLabel
in interface AttributeDescription
public boolean isPrefix()
AttributeDescription
isPrefix
in interface AttributeDescription
public boolean isSystemDefined() throws CSAppFrameworkException
AttributeDescription
isSystemDefined
in interface AttributeDescription
CSAppFrameworkException
public void setPrecision(int precision) throws CSAppFrameworkException
AttributeDescription
setPrecision
in interface AttributeDescription
precision
- the precision
CSAppFrameworkException
public void setPrefix(boolean prefix)
AttributeDescription
setPrefix
in interface AttributeDescription
prefix
- true if the unit label is a prefix, false
for suffix.public void setUnitLabel(java.lang.String unitLabel)
AttributeDescription
setUnitLabel
in interface AttributeDescription
unitLabel
- the unit labelpublic java.lang.String toXML() throws CSAppFrameworkException
AttributeDescription
toXML
in interface AttributeDescription
CSAppFrameworkException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |