Package com.boomi.connector.api.annotation

Class FieldSpec

  • All Implemented Interfaces:
    Serializable
    public class FieldSpec
extends Object
implements Serializable
    Specification for field selection and query sort/filter information on a schema. Specifies whether to ignore child elements when determining filter/sort/field selection fields for the schema.

    Java class for anonymous complex type.

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

     <complexType>
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="field" type="{http://www.boomi.com/connector/annotation}FieldSpecField" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="ignoreForFilters" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="ignoreForSort" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="ignoreForSelection" type="{http://www.w3.org/2001/XMLSchema}boolean" />
     </restriction>
   </complexContent>
 </complexType>
    See Also:
    Serialized Form

    • Field Detail

      • ignoreForFilters

        protected Boolean ignoreForFilters

      • ignoreForSort

        protected Boolean ignoreForSort

      • ignoreForSelection

        protected Boolean ignoreForSelection

      • EMPTY_INSTANCE

        public static final FieldSpec EMPTY_INSTANCE

    • Constructor Detail

      • FieldSpec

        public FieldSpec()

    • Method Detail

      • getFields

        public List<FieldSpecField> getFields()
        Lists any additional field(s) that can be used as a field selection or query sort/filter field but will not be included in the profile Gets the value of the fields 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 fields property.

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

            getFields().add(newItem);

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

      • isIgnoreForFilters

        public Boolean isIgnoreForFilters()
        Indicates that this element and all child elements will be ignored when listing query filter options
        Returns:
        possible object is Boolean

      • setIgnoreForFilters

        public void setIgnoreForFilters​(Boolean value)
        Sets the value of the ignoreForFilters property.
        Parameters:
        value - allowed object is Boolean

      • isIgnoreForSort

        public Boolean isIgnoreForSort()
        Indicates that this element and all child elements will be ignored when listing query sort options
        Returns:
        possible object is Boolean

      • setIgnoreForSort

        public void setIgnoreForSort​(Boolean value)
        Sets the value of the ignoreForSort property.
        Parameters:
        value - allowed object is Boolean

      • isIgnoreForSelection

        public Boolean isIgnoreForSelection()
        Indicates that this element and all child elements will be ignored when listing field selection
        Returns:
        possible object is Boolean

      • setIgnoreForSelection

        public void setIgnoreForSelection​(Boolean value)
        Sets the value of the ignoreForSelection property.
        Parameters:
        value - allowed object is Boolean

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • copy

        public FieldSpec copy()
        Deep copies the fields of the this model into a new instance of this class and returns it.

      • copy

        public FieldSpec copy​(boolean isDeep)
        Copies the fields of the this model (optionally deeply) into a new instance of this class and returns it.

      • copy

        protected FieldSpec copy​(FieldSpec nobj,
                         boolean isDeep)
        Copies the fields of the this model (optionally deeply) into the given instance and returns it.

      • withFields

        public FieldSpec withFields​(FieldSpecField... newValues)
        Adds the given newValues to the current fields property List and returns this instance.

      • withFields

        public FieldSpec withFields​(Collection<? extends FieldSpecField> newValues)
        Adds the given newValues to the current fields property List and returns this instance.

      • withIgnoreForFilters

        public FieldSpec withIgnoreForFilters​(Boolean newValue)
        Sets the ignoreForFilters property to the given newValue and returns this instance.

      • withIgnoreForSort

        public FieldSpec withIgnoreForSort​(Boolean newValue)
        Sets the ignoreForSort property to the given newValue and returns this instance.

      • withIgnoreForSelection

        public FieldSpec withIgnoreForSelection​(Boolean newValue)
        Sets the ignoreForSelection property to the given newValue and returns this instance.