Package com.ibm.di.model.descriptor

Class ParameterDescriptor

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    ModeParameterDescriptor
    public class ParameterDescriptor
extends java.lang.Object
implements java.io.Serializable

    Java class for ParameterDescriptor complex type.

    The following schema fragment specifies the expected content contained within this class. 

     <complexType name="ParameterDescriptor">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="label" type="{http://www.ibm.com/xmlns/prod/tdi/71/core}Label" maxOccurs="unbounded"/>
         <element name="description" type="{http://www.ibm.com/xmlns/prod/tdi/71/core}Label" maxOccurs="unbounded"/>
         <element name="option" type="{http://www.ibm.com/xmlns/prod/tdi/71/core}Option" maxOccurs="unbounded" minOccurs="0"/>
         <element name="defaultValue" type="{http://www.w3.org/2001/XMLSchema}anySimpleType" minOccurs="0"/>
       </sequence>
       <attribute name="key" use="required" type="{http://www.w3.org/2001/XMLSchema}ID" />
       <attribute name="type" use="required" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="hidden" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="required" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
       <attribute name="section" type="{http://www.w3.org/2001/XMLSchema}string" default="general" />
     </restriction>
   </complexContent>
 </complexType>
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object getDefaultValue()
      Gets the value of the defaultValue property.
      java.util.List<Label> getDescriptions()
      Gets the value of the description property.
      java.lang.String getKey()
      Gets the value of the key property.
      java.util.List<Label> getLabels()
      Gets the value of the label property.
      java.lang.String getLeadText()  
      java.lang.String getModes()
      Gets the value of the modes property.
      java.lang.Boolean getNoLabel()  
      java.util.List<Option> getOptions()
      Gets the value of the option property.
      java.lang.String getPanel()  
      java.lang.String getScript()  
      java.lang.String getScript2()  
      java.util.List<Label> getScriptLabels()  
      java.util.List<Label> getScriptLabels2()  
      java.lang.String getSection()
      Gets the value of the section property.
      java.lang.String getType()
      Gets the value of the type property.
      boolean isHidden()
      Gets the value of the hidden property.
      boolean isIndexBased()
      Gets the value of the indexBased property.
      boolean isRequired()
      Gets the value of the required property.
      void setDefaultValue​(java.lang.Object value)
      Sets the value of the defaultValue property.
      void setHidden​(java.lang.Boolean value)
      Sets the value of the hidden property.
      void setIndexBased​(java.lang.Boolean value)
      Sets the value of the indexBased property.
      void setKey​(java.lang.String value)
      Sets the value of the key property.
      void setLeadText​(java.lang.String leadText)  
      void setModes​(java.lang.String value)
      Sets the value of the modes property.
      void setNoLabel​(java.lang.Boolean noLabel)  
      void setPanel​(java.lang.String panel)  
      void setRequired​(java.lang.Boolean value)
      Sets the value of the required property.
      void setScript​(java.lang.String script)
      Getter/Setter for script/scriptLabel
      void setScript2​(java.lang.String script)
      Getter/Setter for script/scriptLabel
      void setSection​(java.lang.String value)
      Sets the value of the section property.
      void setType​(java.lang.String value)
      Sets the value of the type property.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • label

        protected java.util.List<Label> label

      • description

        protected java.util.List<Label> description

      • option

        protected java.util.List<Option> option

      • defaultValue

        protected java.lang.Object defaultValue

      • key

        protected java.lang.String key

      • type

        protected java.lang.String type

      • hidden

        protected java.lang.Boolean hidden

      • required

        protected java.lang.Boolean required

      • section

        protected java.lang.String section

      • modes

        protected java.lang.String modes

      • script

        protected java.lang.String script

      • scriptLabel

        protected java.util.List<Label> scriptLabel

      • script2

        protected java.lang.String script2

      • scriptLabel2

        protected java.util.List<Label> scriptLabel2

      • panel

        protected java.lang.String panel

      • indexBased

        protected java.lang.Boolean indexBased

      • leadText

        protected java.lang.String leadText

      • noLabel

        protected java.lang.Boolean noLabel

    • Constructor Detail

      • ParameterDescriptor

        public ParameterDescriptor()

    • Method Detail

      • getLabels

        public java.util.List<Label> getLabels()
        Gets the value of the label property.

        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 set method for the label property.

        For example, to add a new item, do as follows: 

         getLabel().add(newItem);

        Objects of the following type(s) are allowed in the list Label

      • getDescriptions

        public java.util.List<Label> getDescriptions()
        Gets the value of the description property.

        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 set method for the description property.

        For example, to add a new item, do as follows: 

         getDescription().add(newItem);

        Objects of the following type(s) are allowed in the list Label

      • getOptions

        public java.util.List<Option> getOptions()
        Gets the value of the option property.

        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 set method for the option property.

        For example, to add a new item, do as follows: 

         getOption().add(newItem);

        Objects of the following type(s) are allowed in the list Option

      • getDefaultValue

        public java.lang.Object getDefaultValue()
        Gets the value of the defaultValue property.
        Returns:
        possible object is Object

      • setDefaultValue

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

      • getKey

        public java.lang.String getKey()
        Gets the value of the key property.
        Returns:
        possible object is String

      • setKey

        public void setKey​(java.lang.String value)
        Sets the value of the key property.
        Parameters:
        value - allowed object is String

      • getType

        public java.lang.String getType()
        Gets the value of the type property.
        Returns:
        possible object is String

      • setType

        public void setType​(java.lang.String value)
        Sets the value of the type property.
        Parameters:
        value - allowed object is String

      • isHidden

        public boolean isHidden()
        Gets the value of the hidden property.
        Returns:
        possible object is Boolean

      • setHidden

        public void setHidden​(java.lang.Boolean value)
        Sets the value of the hidden property.
        Parameters:
        value - allowed object is Boolean

      • isRequired

        public boolean isRequired()
        Gets the value of the required property.
        Returns:
        possible object is Boolean

      • setRequired

        public void setRequired​(java.lang.Boolean value)
        Sets the value of the required property.
        Parameters:
        value - allowed object is Boolean

      • getSection

        public java.lang.String getSection()
        Gets the value of the section property.
        Returns:
        possible object is String

      • setSection

        public void setSection​(java.lang.String value)
        Sets the value of the section property.
        Parameters:
        value - allowed object is String

      • getModes

        public java.lang.String getModes()
        Gets the value of the modes property.
        Returns:
        possible object is String

      • setModes

        public void setModes​(java.lang.String value)
        Sets the value of the modes property.
        Parameters:
        value - allowed object is String

      • setScript

        public void setScript​(java.lang.String script)
        Getter/Setter for script/scriptLabel

      • getScript

        public java.lang.String getScript()

      • getScriptLabels

        public java.util.List<Label> getScriptLabels()

      • setScript2

        public void setScript2​(java.lang.String script)
        Getter/Setter for script/scriptLabel

      • getScript2

        public java.lang.String getScript2()

      • getScriptLabels2

        public java.util.List<Label> getScriptLabels2()

      • setPanel

        public void setPanel​(java.lang.String panel)

      • getPanel

        public java.lang.String getPanel()

      • isIndexBased

        public boolean isIndexBased()
        Gets the value of the indexBased property.
        Returns:
        possible object is Boolean

      • setIndexBased

        public void setIndexBased​(java.lang.Boolean value)
        Sets the value of the indexBased property.
        Parameters:
        value - allowed object is Boolean

      • getLeadText

        public java.lang.String getLeadText()

      • setLeadText

        public void setLeadText​(java.lang.String leadText)

      • getNoLabel

        public java.lang.Boolean getNoLabel()

      • setNoLabel

        public void setNoLabel​(java.lang.Boolean noLabel)