com.centrasite.jaxr.type
Interface CentraSiteAttribute

All Known Subinterfaces:
CentraSiteClassificationAttribute, CentraSiteComputedAttribute, CentraSiteFileAttribute, CentraSiteJaxrAttribute, CentraSiteRelationShipAttribute, CentraSiteSlotDescription

public interface CentraSiteAttribute

Common interface for all types of CentraSite attributes.


Field Summary
static java.lang.String MAXOCCURS_1
          The maxOccurs setting if this attribute is not multiple.
static java.lang.String MAXOCCURS_UNBOUNDED
          The maxOccurs setting if this attribute is an multiple.
static java.lang.String MINOCCURS_0
          The minOccurs setting if this attribute is not required.
static java.lang.String MINOCCURS_1
          The minOccurs setting if this attribute is required.
 
Method Summary
 java.lang.Object getDefaultValue()
          Get the default value of this attribute.
 java.lang.String getDescription()
          Get the attribute description.
 java.lang.String getDisplayName()
          Return the attribute's display name.
 java.lang.String getLocalName()
          Return the attribute local name.
 java.lang.String getMaxOccurs()
          Return the maxOccurs setting
 java.lang.String getMinOccurs()
          Return the minOccurs setting.
 java.lang.String getName()
          Return the attribute name.
 boolean hasDefaultValue()
          Return whether a default value is defined for this attribute.
 boolean isReadOnly()
          Return whether this attribute is readonly.
 boolean isRequired()
          Return whether this attribute is required.
 boolean isSystemDefined()
          Return whether this attribute is system-defined.
 boolean isUsed()
          Return whether this attribute is used by at least one instance of the corresponding type.
 void setDefaultValue(java.lang.Object value)
          Set the default value for this attribute.
 void setDescription(java.lang.String description)
          Set the attribute description.
 void setMaxOccurs(java.lang.String maxOccurs)
          Set the maxOccurs value.
 void setMinOccurs(java.lang.String minOccurs)
          Set the minOccurs value.
 void setName(java.lang.String name)
          Set the attribute name.
 void setReadOnly(boolean readOnly)
          Set this attribute's readonly option.
 void setRequired(boolean isRequired)
          Sets whether the attribute is Required or not
 

Field Detail

MAXOCCURS_1

static final java.lang.String MAXOCCURS_1
The maxOccurs setting if this attribute is not multiple.

See Also:
Constant Field Values

MAXOCCURS_UNBOUNDED

static final java.lang.String MAXOCCURS_UNBOUNDED
The maxOccurs setting if this attribute is an multiple.

See Also:
Constant Field Values

MINOCCURS_0

static final java.lang.String MINOCCURS_0
The minOccurs setting if this attribute is not required.

See Also:
Constant Field Values

MINOCCURS_1

static final java.lang.String MINOCCURS_1
The minOccurs setting if this attribute is required.

See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Return the attribute name.

Returns:
the attribute name

getLocalName

java.lang.String getLocalName()
Return the attribute local name.

Returns:
the attribute local name

getDisplayName

java.lang.String getDisplayName()
Return the attribute's display name. If the display name was not provided return the name.

Returns:
the attribute's display name

setName

void setName(java.lang.String name)
Set the attribute name.

Parameters:
name - the attribute name

getDescription

java.lang.String getDescription()
Get the attribute description.

Returns:
the attribute description

setDescription

void setDescription(java.lang.String description)
Set the attribute description.

Parameters:
description - the attribute description

getMinOccurs

java.lang.String getMinOccurs()
Return the minOccurs setting.

Returns:
MINOCCURS_0 if this attribute is optional, MINOCCURS_1 if this attribute is required

setMinOccurs

void setMinOccurs(java.lang.String minOccurs)
Set the minOccurs value. The default value is MINOCCURS_0.

Parameters:
minOccurs - the minOccurs value

getMaxOccurs

java.lang.String getMaxOccurs()
Return the maxOccurs setting

Returns:
MAXOCCURS_UNBOUNDED if this attribute is multiple, MAXOCCURS_1 otherwise

setMaxOccurs

void setMaxOccurs(java.lang.String maxOccurs)
Set the maxOccurs value. The default value is MAXOCCURS_UNBOUNDED.

Parameters:
maxOccurs - the maxOccurs value

isRequired

boolean isRequired()
Return whether this attribute is required.

Returns:
true if this attribute is required

setRequired

void setRequired(boolean isRequired)
Sets whether the attribute is Required or not

Parameters:
isRequired - The value to set

isReadOnly

boolean isReadOnly()
Return whether this attribute is readonly.

Returns:
true if this attribute is readonly

setReadOnly

void setReadOnly(boolean readOnly)
Set this attribute's readonly option. By default, the readonly option is false.

Parameters:
readOnly - true if this attribute is readonly

hasDefaultValue

boolean hasDefaultValue()
Return whether a default value is defined for this attribute.

Returns:
true if a default value is defined for this attribute

getDefaultValue

java.lang.Object getDefaultValue()
Get the default value of this attribute.

Returns:
the default value of this attribute, or null if there is no default value.

setDefaultValue

void setDefaultValue(java.lang.Object value)
                     throws java.lang.Exception
Set the default value for this attribute.
  • For all XML schema simple types ("xs:...") and the CentraSite-defined simple types (CS:ipv4_type, CS:ipv6_type, CS:emailAddress_type) the default value is a String.
  • For classification attributes, the default value is a Concept.
  • For CS:internationalStringType the default value is a javax.xml.registry.infomodel.InternationalString.
  • For CS:richText_type the default value is a CentraSiteRichText.
  • For CS:internationalRichText_type the default value is a CentraSiteInternationalRichText.

    Parameters:
    value - the default value for this attribute. null means no default value.
    Throws:
    java.lang.Exception

  • isUsed

    boolean isUsed()
                   throws javax.xml.registry.JAXRException
    Return whether this attribute is used by at least one instance of the corresponding type.

    Returns:
    true if this attribute is used by at least one instance
    Throws:
    javax.xml.registry.JAXRException

    isSystemDefined

    boolean isSystemDefined()
                            throws javax.xml.registry.JAXRException
    Return whether this attribute is system-defined.

    Returns:
    true if this attribute is system-defined.
    Throws:
    javax.xml.registry.JAXRException