com.centrasite.jaxr.type
Interface CentraSiteSlotDescription

All Superinterfaces:
CentraSiteAttribute

public interface CentraSiteSlotDescription
extends CentraSiteAttribute

Describes a slot's properties as given by the corresponding object type definition.

  • name
  • description
  • datatype
  • minOccurs
  • maxOccurs
  • enumeration values
  • default value
  • readonly
  • longString
  • indexed
  • unit label (prefix/suffix)
  • is Required


    Field Summary
     
    Fields inherited from interface com.centrasite.jaxr.type.CentraSiteAttribute
    MAXOCCURS_1, MAXOCCURS_UNBOUNDED, MINOCCURS_0, MINOCCURS_1
     
    Method Summary
     void addTriggerDescription(CentraSiteTriggerDescription trigger)
              Deprecated.  
     void checkValidLocalName(java.lang.String value, java.util.Locale lc)
              Check string whether a valid local name for a type definition
     void checkValidValue(java.lang.String value)
              Check string whether a valid value for this slot
     void clearTriggers()
              Deprecated.  
     java.lang.String getDataType()
              Return the data type which is an XML schema type
     java.lang.String getDisplayName()
              Return the attribute's display name.
     java.lang.String[] getEnumValues()
              Get enumeration values.
     java.lang.String getLocalName()
              Get the slot local name (no namespace).
     java.lang.String getName()
              Return the slot name as {uri}local-name
     int getPrecision()
              Get the precision for a "number" slot.
     java.util.Collection getTriggerDescriptions()
              Deprecated.  
     java.lang.String getUnitLabel()
              Return this slot's unit label.
     boolean hasTriggers()
              Deprecated.  
     boolean hasValidInputFields()
              Are the input fields valid?
     boolean isFullySpecified()
              Is the slot fully specified?
     boolean isIndexed()
              Return whether a database index is defined for this slot
     boolean isLongString()
              Return whether the LongString option is set
     boolean isPrefix()
              Return whether this slot's unit label is a prefix or suffix value.
     boolean isRequired()
              Returns the isRequired setting which says whether the attribute is required
     boolean isSystemDefined()
              Return whether this slot is system defined.
     boolean isUsed()
              Return whether this slot is used by at least one instance of the corresponding type.
     void setDataType(java.lang.String type)
              Set the data type.
     void setDisplayName(java.lang.String displayName)
              Set the attribute's display name.
     void setEnumValues(java.lang.String[] enumValues)
              Set enumeration values.
     void setIndexed(boolean indexed)
              Set this slot's indexed option.
     void setLongString(boolean longString)
              Set the LongString option.
     void setName(java.lang.String name)
              Set the slot name.
     void setPrecision(int precision)
              Set the precision for a "number" slot.
     void setPrefix(boolean prefix)
              Specify whether this slot's unit label is to be a prefix or suffix value.
     void setRequired(boolean isRequired)
              Sets the isRequired value.
     void setSystemDefined(boolean systemDefined)
              Set this slot's system defined option.
     void setUnitLabel(java.lang.String unitLabel)
              Set this slot's unit label.
     java.lang.String toXML()
              Get XML representation (schema).
     
    Methods inherited from interface com.centrasite.jaxr.type.CentraSiteAttribute
    getDefaultValue, getDescription, getMaxOccurs, getMinOccurs, hasDefaultValue, isReadOnly, setDefaultValue, setDescription, setMaxOccurs, setMinOccurs, setReadOnly
     

    Method Detail

    getName

    java.lang.String getName()
    Return the slot name as {uri}local-name

    Specified by:
    getName in interface CentraSiteAttribute
    Returns:
    the slot name

    setName

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

    Specified by:
    setName in interface CentraSiteAttribute
    Parameters:
    name - the slot name

    getLocalName

    java.lang.String getLocalName()
    Get the slot local name (no namespace).

    Specified by:
    getLocalName in interface CentraSiteAttribute
    Returns:
    slot local name (no namespace)

    setDisplayName

    void setDisplayName(java.lang.String displayName)
    Set the attribute's display name.

    Parameters:
    displayName - the attribute's display name

    getDisplayName

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

    Specified by:
    getDisplayName in interface CentraSiteAttribute
    Returns:
    the attribute's display name

    getDataType

    java.lang.String getDataType()
    Return the data type which is an XML schema type

    Returns:
    the data type (not null)

    setDataType

    void setDataType(java.lang.String type)
    Set the data type.

    Parameters:
    type - the data type

    getEnumValues

    java.lang.String[] getEnumValues()
    Get enumeration values.

    Returns:
    enumeration values

    setEnumValues

    void setEnumValues(java.lang.String[] enumValues)
    Set enumeration values.

    Parameters:
    enumValues - enumeration values

    clearTriggers

    void clearTriggers()
    Deprecated. 

    Clear collection of triggers (GUI).


    hasTriggers

    boolean hasTriggers()
    Deprecated. 

    Has this slot any triggers?

    Returns:
    true if associated triggers, false otherwise

    addTriggerDescription

    void addTriggerDescription(CentraSiteTriggerDescription trigger)
    Deprecated. 

    Add trigger description to slot.

    Parameters:
    trigger - trigger to add

    getTriggerDescriptions

    java.util.Collection getTriggerDescriptions()
    Deprecated. 

    Get all triggers for slot.

    Returns:
    collection of CentraSiteTriggerDescription (may be empty but not null)

    toXML

    java.lang.String toXML()
                           throws javax.xml.registry.JAXRException
    Get XML representation (schema).

    Returns:
    XML representation (schema)
    Throws:
    javax.xml.registry.JAXRException

    hasValidInputFields

    boolean hasValidInputFields()
    Are the input fields valid?

    Returns:
    true if valid input fields, false otherwise

    isFullySpecified

    boolean isFullySpecified()
    Is the slot fully specified?

    Returns:
    true if fully specified, false if not

    checkValidLocalName

    void checkValidLocalName(java.lang.String value,
                             java.util.Locale lc)
                             throws java.lang.Exception
    Check string whether a valid local name for a type definition

    Parameters:
    value - the string to be checked
    Throws:
    java.lang.Exception

    checkValidValue

    void checkValidValue(java.lang.String value)
                         throws java.lang.Exception
    Check string whether a valid value for this slot

    Parameters:
    value - the string to be checked
    Throws:
    java.lang.Exception

    isSystemDefined

    boolean isSystemDefined()
    Return whether this slot is system defined.

    Specified by:
    isSystemDefined in interface CentraSiteAttribute
    Returns:
    true if this slot is system defined

    setSystemDefined

    void setSystemDefined(boolean systemDefined)
    Set this slot's system defined option. By default, the system defined option is false.

    Parameters:
    systemDefined - true if this slot is system defined

    isIndexed

    boolean isIndexed()
    Return whether a database index is defined for this slot

    Returns:
    true if a database index is defined for this slot

    setIndexed

    void setIndexed(boolean indexed)
    Set this slot's indexed option.

    Parameters:
    indexed - true if a database index is to be created for this slot

    setUnitLabel

    void setUnitLabel(java.lang.String unitLabel)
    Set this slot's unit label. By default this is a prefix value.

    Parameters:
    unitLabel - the unit label

    getUnitLabel

    java.lang.String getUnitLabel()
    Return this slot's unit label.

    Returns:
    the unit label. May be null.

    setPrefix

    void setPrefix(boolean prefix)
    Specify whether this slot's unit label is to be a prefix or suffix value.

    Parameters:
    prefix - true if the unit label is a prefix, false for suffix.

    isPrefix

    boolean isPrefix()
    Return whether this slot's unit label is a prefix or suffix value.

    Returns:
    true if the unit label is a prefix, false for suffix.

    isUsed

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

    Specified by:
    isUsed in interface CentraSiteAttribute
    Returns:
    true if this slot is used by at least one instance
    Throws:
    javax.xml.registry.JAXRException

    setPrecision

    void setPrecision(int precision)
                      throws javax.xml.registry.JAXRException
    Set the precision for a "number" slot.

    Parameters:
    precision - the precision
    Throws:
    javax.xml.registry.JAXRException

    getPrecision

    int getPrecision()
                     throws javax.xml.registry.JAXRException
    Get the precision for a "number" slot.

    Returns:
    the precision
    Throws:
    javax.xml.registry.JAXRException

    isLongString

    boolean isLongString()
    Return whether the LongString option is set

    Returns:
    true if the LongString option is set

    setLongString

    void setLongString(boolean longString)
    Set the LongString option.

    Parameters:
    longString - true if the LongString option is to be set

    isRequired

    boolean isRequired()
    Returns the isRequired setting which says whether the attribute is required

    Specified by:
    isRequired in interface CentraSiteAttribute
    Returns:
    true if the attribute is mandatory and false otherwise

    setRequired

    void setRequired(boolean isRequired)
    Sets the isRequired value. The default value is false

    Specified by:
    setRequired in interface CentraSiteAttribute
    Parameters:
    isRequired - the isRequired value to set