public interface CentraSiteObjectAttribute
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TYPE_APIPortal |
static java.lang.String |
TYPE_CLASSIFICATION |
static java.lang.String |
TYPE_COMMON |
static java.lang.String |
TYPE_COMPUTED |
static java.lang.String |
TYPE_EXTENSION |
static java.lang.String |
TYPE_FILE |
static java.lang.String |
TYPE_NATIVE_SERVICE |
static java.lang.String |
TYPE_OBJECT |
static java.lang.String |
TYPE_ORGANIZATION |
static java.lang.String |
TYPE_PERMISSION |
static java.lang.String |
TYPE_POLICY |
static java.lang.String |
TYPE_RELATIONSHIP |
static java.lang.String |
TYPE_REPORT_ATTRIBUTE |
static java.lang.String |
TYPE_ROLE |
static java.lang.String |
TYPE_SIMPLE |
static java.lang.String |
TYPE_USER |
static java.lang.String |
TYPE_VIRTUAL |
Modifier and Type | Method and Description |
---|---|
CentraSiteRegistryObjectType |
getCentraSiteObjectType()
Gets the underlying registry object type for this attribute.
|
java.lang.String |
getDataType()
Returns the data type of the CentraSite Object Attribute.
|
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 |
isComputedAttribute()
Checks if this attribute is a computed attribute or not.
|
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.
|
boolean |
isVisibleInSearch()
Returns a boolean value to determine if the CentraSite Object Attribute is visible in search or not
|
static final java.lang.String TYPE_CLASSIFICATION
static final java.lang.String TYPE_COMMON
static final java.lang.String TYPE_COMPUTED
static final java.lang.String TYPE_FILE
static final java.lang.String TYPE_RELATIONSHIP
static final java.lang.String TYPE_SIMPLE
static final java.lang.String TYPE_REPORT_ATTRIBUTE
static final java.lang.String TYPE_ORGANIZATION
static final java.lang.String TYPE_USER
static final java.lang.String TYPE_ROLE
static final java.lang.String TYPE_POLICY
static final java.lang.String TYPE_OBJECT
static final java.lang.String TYPE_PERMISSION
static final java.lang.String TYPE_APIPortal
static final java.lang.String TYPE_VIRTUAL
static final java.lang.String TYPE_NATIVE_SERVICE
static final java.lang.String TYPE_EXTENSION
javax.xml.namespace.QName getQName() throws CLLException
QName
of the CentraSite Object Attribute.CLLException
- If an error occurs in getting the QNamejava.lang.String getName() throws CLLException
CLLException
- If encountered with an error while fetching the attribute namejava.lang.String getDisplayName() throws CLLException
CLLException
- If an error occurs in getting the attribute's display namejava.lang.String getDisplayName(java.util.Locale locale) throws CLLException
locale
- The Locale
in which the display name should be retrievedCLLException
- If an error occurs while getting the attribute's display namejava.lang.String getDescription() throws CLLException
CLLException
- If an error occurs while fetching the attribute descriptionjava.lang.String getDescription(java.util.Locale locale) throws CLLException
locale
- The Locale
in which the description should be retrievedCLLException
- If an error occurs while fetching the attribute descriptionboolean isReadOnly() throws CLLException
CLLException
- If an error occurs in determining whether the attribute is read-only or notboolean isRequired() throws CLLException
CLLException
- If an error occurs in determining whether the attribute is required or notboolean isMultiValued() throws CLLException
CLLException
- If an error occurs in determining whether the attribute takes multiples valuesjava.lang.Object getDefaultValue() throws CLLException
CLLException
- If an error occurs in getting the attribute's default valuejava.lang.String getDataType() throws CLLException
String
of the CentraSite Object AttributeCLLException
- If an error occurs in determining the attribute data typejava.lang.String getType()
CentraSiteRegistryObjectType getCentraSiteObjectType()
CentraSiteRegistryObjectType
instance if available and for custom attributes which do not have
an underlying registry object, returns nullboolean isComputedAttribute()
boolean isVisibleInSearch()