Class AttachmentDefinition

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    Attachment

    public class AttachmentDefinition
    extends ComponentReference
    implements java.io.Serializable
    Definition of an expected task attachment <p>Java class for AttachmentDefinition complex type. <p>The following schema fragment specifies the expected content contained within this class. <pre> &lt;complexType name="AttachmentDefinition"&gt; &lt;complexContent&gt; &lt;extension base="{http://flower.com/docs/domain/component}ComponentReference"&gt; &lt;sequence&gt; &lt;element name="classId" type="{http://flower.com/docs/domain/common}Id"/&gt; &lt;element name="displayNames" type="{http://flower.com/docs/domain/i18n}I18NLabel" maxOccurs="unbounded"/&gt; &lt;element ref="{http://flower.com/docs/domain/component}Tags" minOccurs="0"/&gt; &lt;element name="description" type="{http://www.w3.org/2001/XMLSchema}string"/&gt; &lt;element name="synopsis" type="{http://flower.com/docs/domain/i18n}I18NLabel" maxOccurs="unbounded" minOccurs="0"/&gt; &lt;/sequence&gt; &lt;attribute name="multivalued" type="{http://www.w3.org/2001/XMLSchema}boolean" /&gt; &lt;attribute name="readonly" type="{http://www.w3.org/2001/XMLSchema}boolean" /&gt; &lt;attribute name="required" type="{http://flower.com/docs/domain/taskclass}Required" /&gt; &lt;attribute name="technical" type="{http://www.w3.org/2001/XMLSchema}boolean" /&gt; &lt;attribute name="order" use="required" type="{http://www.w3.org/2001/XMLSchema}int" /&gt; &lt;/extension&gt; &lt;/complexContent&gt; &lt;/complexType&gt; </pre>
    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected Id classId
      The component class identifier of the expected attachment
      protected java.lang.String description
      A generic description of the attachment
      protected java.util.List<I18NLabel> displayNames  
      protected java.lang.Boolean multivalued
      Determines if the referenced attachment is multivalued or monovalued
      protected int order
      The display order of the attachment
      protected java.lang.Boolean readonly
      Determines if the attachment is readonly or not
      protected Required required
      Determines if the attachment is mandatory or not
      protected java.util.List<I18NLabel> synopsis  
      protected Tags tags  
      protected java.lang.Boolean technical
      Determines if the attachment is technical.
    • Constructor Summary

      Constructors 
      Constructor Description
      AttachmentDefinition()
      Default no-arg constructor abc
      AttachmentDefinition​(Id id, Category category, Id classId, java.util.List<I18NLabel> displayNames, Tags tags, java.lang.String description, java.util.List<I18NLabel> synopsis, java.lang.Boolean multivalued, java.lang.Boolean readonly, Required required, java.lang.Boolean technical, int order)
      Fully-initialising value constructor
    • Field Detail

      • classId

        protected Id classId
        The component class identifier of the expected attachment
      • displayNames

        protected java.util.List<I18NLabel> displayNames
      • tags

        protected Tags tags
      • description

        protected java.lang.String description
        A generic description of the attachment
      • synopsis

        protected java.util.List<I18NLabel> synopsis
      • multivalued

        protected java.lang.Boolean multivalued
        Determines if the referenced attachment is multivalued or monovalued
      • readonly

        protected java.lang.Boolean readonly
        Determines if the attachment is readonly or not
      • required

        protected Required required
        Determines if the attachment is mandatory or not
      • technical

        protected java.lang.Boolean technical
        Determines if the attachment is technical. Technical attachments should not be displayed to users
      • order

        protected int order
        The display order of the attachment
    • Constructor Detail

      • AttachmentDefinition

        public AttachmentDefinition()
        Default no-arg constructor abc
      • AttachmentDefinition

        public AttachmentDefinition​(Id id,
                                    Category category,
                                    Id classId,
                                    java.util.List<I18NLabel> displayNames,
                                    Tags tags,
                                    java.lang.String description,
                                    java.util.List<I18NLabel> synopsis,
                                    java.lang.Boolean multivalued,
                                    java.lang.Boolean readonly,
                                    Required required,
                                    java.lang.Boolean technical,
                                    int order)
        Fully-initialising value constructor
    • Method Detail

      • getClassId

        public Id getClassId()
        Gets the value of the classId property. <p> The component class identifier of the expected attachment
        Returns:
        possible object is Id
      • setClassId

        public void setClassId​(Id value)
        Sets the value of the classId property.
        Parameters:
        value - allowed object is Id
        See Also:
        getClassId()
      • getDisplayNames

        public java.util.List<I18NLabel> getDisplayNames()
        Gets the value of the displayNames 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 displayNames property. <p> For example, to add a new item, do as follows: <pre> getDisplayNames().add(newItem); </pre> <p> Objects of the following type(s) are allowed in the list I18NLabel
      • getTags

        public Tags getTags()
        Expected tags of task attachment
        Returns:
        possible object is Tags
      • setTags

        public void setTags​(Tags value)
        Sets the value of the tags property.
        Parameters:
        value - allowed object is Tags
      • getDescription

        public java.lang.String getDescription()
        Gets the value of the description property. <p> A generic description of the attachment
        Returns:
        possible object is String
      • setDescription

        public void setDescription​(java.lang.String value)
        Sets the value of the description property.
        Parameters:
        value - allowed object is String
        See Also:
        getDescription()
      • getSynopsis

        public java.util.List<I18NLabel> getSynopsis()
        Gets the value of the synopsis 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 synopsis property. <p> For example, to add a new item, do as follows: <pre> getSynopsis().add(newItem); </pre> <p> Objects of the following type(s) are allowed in the list I18NLabel
      • isMultivalued

        public java.lang.Boolean isMultivalued()
        Gets the value of the multivalued property. <p> Determines if the referenced attachment is multivalued 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()
      • isReadonly

        public java.lang.Boolean isReadonly()
        Gets the value of the readonly property. <p> Determines if the attachment is readonly or not
        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()
      • getRequired

        public Required getRequired()
        Gets the value of the required property. <p> Determines if the attachment is mandatory or not
        Returns:
        possible object is Required
      • setRequired

        public void setRequired​(Required value)
        Sets the value of the required property.
        Parameters:
        value - allowed object is Required
        See Also:
        getRequired()
      • isTechnical

        public java.lang.Boolean isTechnical()
        Gets the value of the technical property. <p> Determines if the attachment is technical. Technical attachments should not be displayed to users
        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()
      • getOrder

        public int getOrder()
        Gets the value of the order property. <p> The display order of the attachment
      • setOrder

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

        public void setDisplayNames​(java.util.List<I18NLabel> value)
      • setSynopsis

        public void setSynopsis​(java.util.List<I18NLabel> value)