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

All Known Subinterfaces:
ClassificationAttribute, CommonAttribute, CSOComputedAttribute, FileAttribute, RelationShipAttribute, ReportAttribute, SimpleAttribute

public interface CentraSiteObjectAttribute

Depicts an attribute of any CentraSiteObject. This interface provides the constants for representing attributes and the methods that operate upon them.


Field Summary
static java.lang.String TYPE_CLASSIFICATION
           
static java.lang.String TYPE_COMMON
           
static java.lang.String TYPE_COMPUTED
           
static java.lang.String TYPE_FILE
           
static java.lang.String TYPE_RELATIONSHIP
           
static java.lang.String TYPE_REPORT_ATTRIBUTE
           
static java.lang.String TYPE_SIMPLE
           
 
Method Summary
 CentraSiteRegistryObjectType getCentraSiteObjectType()
           
 java.lang.String getDataType()
          Returns the data type of the CentraSite Object Attribute value is of.
 java.lang.Object getDefaultValue()
          Returns the default value of the CentraSite Object Attribute, if present.
 java.lang.String getDescription()
          Retrieves the description of the CentraSite Object Attribute.
 java.lang.String getDescription(java.util.Locale locale)
          Retrieves the description of the CentraSite Object Attribute in the specified locale.
 java.lang.String getDisplayName()
          Retrieves the display name of the CentraSite Object Attribute in the current user's locale.
 java.lang.String getDisplayName(java.util.Locale locale)
          Retrieves the display name of the CentraSite Object Attribute in the specified locale.
 java.lang.String getName()
          Retrieves the name of the CentraSite Object Attribute.
 javax.xml.namespace.QName getQName()
          Retrieves the fully qualified name of the CentraSite Object Attribute.
 java.lang.String getType()
          Returns the type of the CentraSite Object Attribute.
 boolean isMultiValued()
          Returns a boolean value to determine if the CentraSite Object Attribute is multi-valued or not.
 boolean isReadOnly()
          Returns a boolean value to determine if the CentraSite Object Attribute is read-only or not.
 boolean isRequired()
          Returns a boolean value to determine if the CentraSite Object Attribute requires a value or not.
 

Field Detail

TYPE_CLASSIFICATION

static final java.lang.String TYPE_CLASSIFICATION
See Also:
Constant Field Values

TYPE_COMMON

static final java.lang.String TYPE_COMMON
See Also:
Constant Field Values

TYPE_COMPUTED

static final java.lang.String TYPE_COMPUTED
See Also:
Constant Field Values

TYPE_FILE

static final java.lang.String TYPE_FILE
See Also:
Constant Field Values

TYPE_RELATIONSHIP

static final java.lang.String TYPE_RELATIONSHIP
See Also:
Constant Field Values

TYPE_SIMPLE

static final java.lang.String TYPE_SIMPLE
See Also:
Constant Field Values

TYPE_REPORT_ATTRIBUTE

static final java.lang.String TYPE_REPORT_ATTRIBUTE
See Also:
Constant Field Values
Method Detail

getQName

javax.xml.namespace.QName getQName()
Retrieves the fully qualified name of the CentraSite Object Attribute.

Returns:
the QName of the CentraSite Object Attribute.

getName

java.lang.String getName()
Retrieves the name of the CentraSite Object Attribute.

Returns:
the name of the CentraSite Object Attribute.

getDisplayName

java.lang.String getDisplayName()
                                throws CLLException
Retrieves the display name of the CentraSite Object Attribute in the current user's locale.

Returns:
the display name of the CentraSite Object Attribute in the current user's locale.
Throws:
CLLException

getDisplayName

java.lang.String getDisplayName(java.util.Locale locale)
                                throws CLLException
Retrieves the display name of the CentraSite Object Attribute in the specified locale.

Returns:
the display name of the CentraSite Object Attribute in the specified locale.
Throws:
CLLException

getDescription

java.lang.String getDescription()
                                throws CLLException
Retrieves the description of the CentraSite Object Attribute.

Returns:
the description of the CentraSite Object Attribute.
Throws:
CLLException

getDescription

java.lang.String getDescription(java.util.Locale locale)
                                throws CLLException
Retrieves the description of the CentraSite Object Attribute in the specified locale.

Returns:
the description of the CentraSite Object Attribute in the specified locale.
Throws:
CLLException

isReadOnly

boolean isReadOnly()
                   throws CLLException
Returns a boolean value to determine if the CentraSite Object Attribute is read-only or not.

Returns:
a boolean value to determine if the CentraSite Object Attribute is read-only or not.
Throws:
CLLException

isRequired

boolean isRequired()
                   throws CLLException
Returns a boolean value to determine if the CentraSite Object Attribute requires a value or not.

Returns:
a boolean value to determine if the CentraSite Object Attribute requires a value or not.
Throws:
CLLException

isMultiValued

boolean isMultiValued()
Returns a boolean value to determine if the CentraSite Object Attribute is multi-valued or not.

Returns:
a boolean value to determine if the CentraSite Object Attribute is multi-valued or not.

getDefaultValue

java.lang.Object getDefaultValue()
                                 throws CLLException
Returns the default value of the CentraSite Object Attribute, if present.

Returns:
the default value of the CentraSite Object Attribute, if present.
Throws:
CLLException

getDataType

java.lang.String getDataType()
Returns the data type of the CentraSite Object Attribute value is of.

Returns:
the data type of the CentraSite Object Attribute value is of.

getType

java.lang.String getType()
Returns the type of the CentraSite Object Attribute.

Returns:
the type of the CentraSite Object Attribute.

getCentraSiteObjectType

CentraSiteRegistryObjectType getCentraSiteObjectType()