Package com.flower.docs.domain.tagclass

Class TagReference

  • All Implemented Interfaces:
    HasDescription, java.io.Serializable
    public class TagReference
extends java.lang.Object
implements java.io.Serializable, HasDescription
    Reference to a usage of a tag in a component class <p>Java class for TagReference complex type. <p>The following schema fragment specifies the expected content contained within this class. <pre> &lt;complexType name="TagReference"&gt; &lt;complexContent&gt; &lt;restriction base="{http://www.w3.org/2001/XMLSchema}anyType"&gt; &lt;sequence&gt; &lt;element name="descriptions" type="{http://flower.com/docs/domain/i18n}I18NLabel" maxOccurs="unbounded" minOccurs="0"/&gt; &lt;element name="pattern" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/&gt; &lt;/sequence&gt; &lt;attribute name="tagName" type="{http://www.w3.org/2001/XMLSchema}string" /&gt; &lt;attribute name="mandatory" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" /&gt; &lt;attribute name="multivalued" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" /&gt; &lt;attribute name="technical" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" /&gt; &lt;attribute name="readonly" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" /&gt; &lt;attribute name="order" use="required" type="{http://www.w3.org/2001/XMLSchema}int" /&gt; &lt;attribute name="defaultValue" type="{http://www.w3.org/2001/XMLSchema}string" /&gt; &lt;/restriction&gt; &lt;/complexContent&gt; &lt;/complexType&gt; </pre>
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String defaultValue
      The default value of each tag instances
      protected java.util.List<I18NLabel> descriptions
      Internationalized descriptions of the tag usage
      protected java.lang.Boolean mandatory
      Determines if the referenced tag class is mandatory or not
      protected java.lang.Boolean multivalued
      Determines if the referenced tag class is multivaled or monovalued
      protected int order
      The display order of the referenced tag class
      protected java.lang.String pattern
      The regular expression used to validate tag values.
      protected java.lang.Boolean readonly
      Determines if the referenced tag class is readonly post-creation
      protected java.lang.String tagName
      The id value of the referenced tag class
      protected java.lang.Boolean technical
      Determines if the referenced tag class is for a technical usage

    • Constructor Summary

      Constructors 
      Constructor Description
      TagReference()
      Default no-arg constructor abc
      TagReference​(java.util.List<I18NLabel> descriptions, java.lang.String pattern, java.lang.String tagName, java.lang.Boolean mandatory, java.lang.Boolean multivalued, java.lang.Boolean technical, java.lang.Boolean readonly, int order, java.lang.String defaultValue)
      Fully-initialising value constructor

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object other)  
      java.lang.String getDefaultValue()
      Gets the value of the defaultValue property.
      java.util.List<I18NLabel> getDescriptions()
      Gets the value of the descriptions property.
      int getOrder()
      Gets the value of the order property.
      java.lang.String getPattern()
      Gets the value of the pattern property.
      java.lang.String getTagName()
      Gets the value of the tagName property.
      int hashCode()  
      boolean isMandatory()
      Gets the value of the mandatory property.
      boolean isMultivalued()
      Gets the value of the multivalued property.
      boolean isReadonly()
      Gets the value of the readonly property.
      boolean isTechnical()
      Gets the value of the technical property.
      void setDefaultValue​(java.lang.String value)
      Sets the value of the defaultValue property.
      void setDescriptions​(java.util.List<I18NLabel> value)
      Sets the internationalized descriptions
      void setMandatory​(java.lang.Boolean value)
      Sets the value of the mandatory property.
      void setMultivalued​(java.lang.Boolean value)
      Sets the value of the multivalued property.
      void setOrder​(int value)
      Sets the value of the order property.
      void setPattern​(java.lang.String value)
      Sets the value of the pattern property.
      void setReadonly​(java.lang.Boolean value)
      Sets the value of the readonly property.
      void setTagName​(java.lang.String value)
      Sets the value of the tagName property.
      void setTechnical​(java.lang.Boolean value)
      Sets the value of the technical property.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • descriptions

        protected java.util.List<I18NLabel> descriptions
        Internationalized descriptions of the tag usage

      • pattern

        protected java.lang.String pattern
        The regular expression used to validate tag values. If the pattern is set, it overrides pattern defines at tag class level

      • tagName

        protected java.lang.String tagName
        The id value of the referenced tag class

      • mandatory

        protected java.lang.Boolean mandatory
        Determines if the referenced tag class is mandatory or not

      • multivalued

        protected java.lang.Boolean multivalued
        Determines if the referenced tag class is multivaled or monovalued

      • technical

        protected java.lang.Boolean technical
        Determines if the referenced tag class is for a technical usage

      • readonly

        protected java.lang.Boolean readonly
        Determines if the referenced tag class is readonly post-creation

      • order

        protected int order
        The display order of the referenced tag class

      • defaultValue

        protected java.lang.String defaultValue
        The default value of each tag instances

    • Constructor Detail

      • TagReference

        public TagReference()
        Default no-arg constructor abc

      • TagReference

        public TagReference​(java.util.List<I18NLabel> descriptions,
                    java.lang.String pattern,
                    java.lang.String tagName,
                    java.lang.Boolean mandatory,
                    java.lang.Boolean multivalued,
                    java.lang.Boolean technical,
                    java.lang.Boolean readonly,
                    int order,
                    java.lang.String defaultValue)
        Fully-initialising value constructor

    • Method Detail

      • getDescriptions

        public java.util.List<I18NLabel> getDescriptions()
        Gets the value of the descriptions property. <p> This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the descriptions property. <p> For example, to add a new item, do as follows: <pre> getDescriptions().add(newItem); </pre> <p> Objects of the following type(s) are allowed in the list I18NLabel <p> Internationalized descriptions of the tag usage
        Specified by:
        getDescriptions in interface HasDescription
        Returns:
        The descriptions as I18NLabel

      • getPattern

        public java.lang.String getPattern()
        Gets the value of the pattern property. <p> The regular expression used to validate tag values. If the pattern is set, it overrides pattern defines at tag class level
        Returns:
        possible object is String

      • setPattern

        public void setPattern​(java.lang.String value)
        Sets the value of the pattern property.
        Parameters:
        value - allowed object is String
        See Also:
        getPattern()

      • getTagName

        public java.lang.String getTagName()
        Gets the value of the tagName property. <p> The id value of the referenced tag class
        Returns:
        possible object is String

      • setTagName

        public void setTagName​(java.lang.String value)
        Sets the value of the tagName property.
        Parameters:
        value - allowed object is String
        See Also:
        getTagName()

      • isMandatory

        public boolean isMandatory()
        Gets the value of the mandatory property. <p> Determines if the referenced tag class is mandatory or not
        Returns:
        possible object is Boolean

      • setMandatory

        public void setMandatory​(java.lang.Boolean value)
        Sets the value of the mandatory property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isMandatory()

      • isMultivalued

        public boolean isMultivalued()
        Gets the value of the multivalued property. <p> Determines if the referenced tag class is multivaled or monovalued
        Returns:
        possible object is Boolean

      • setMultivalued

        public void setMultivalued​(java.lang.Boolean value)
        Sets the value of the multivalued property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isMultivalued()

      • isTechnical

        public boolean isTechnical()
        Gets the value of the technical property. <p> Determines if the referenced tag class is for a technical usage
        Returns:
        possible object is Boolean

      • setTechnical

        public void setTechnical​(java.lang.Boolean value)
        Sets the value of the technical property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isTechnical()

      • isReadonly

        public boolean isReadonly()
        Gets the value of the readonly property. <p> Determines if the referenced tag class is readonly post-creation
        Returns:
        possible object is Boolean

      • setReadonly

        public void setReadonly​(java.lang.Boolean value)
        Sets the value of the readonly property.
        Parameters:
        value - allowed object is Boolean
        See Also:
        isReadonly()

      • getOrder

        public int getOrder()
        Gets the value of the order property. <p> The display order of the referenced tag class

      • setOrder

        public void setOrder​(int value)
        Sets the value of the order property.
        See Also:
        getOrder()

      • getDefaultValue

        public java.lang.String getDefaultValue()
        Gets the value of the defaultValue property. <p> The default value of each tag instances
        Returns:
        possible object is String

      • setDefaultValue

        public void setDefaultValue​(java.lang.String value)
        Sets the value of the defaultValue property.
        Parameters:
        value - allowed object is String
        See Also:
        getDefaultValue()

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object