ItemSearchType (Generated 4.3.8 API)

java.lang.Object
- com.vidispine.generated.ItemSearchType

All Implemented Interfaces:: Serializable, Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo

Direct Known Subclasses:: FileSearchType, ShapeSearchType

public class ItemSearchType
extends Object
implements Serializable, Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo

Java class for ItemSearchType complex type.

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

 <complexType name="ItemSearchType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="text" type="{http://xml.vidispine.com/schema/vidispine}ItemSearchTextValueType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="field" type="{http://xml.vidispine.com/schema/vidispine}SearchFieldType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="group" type="{http://xml.vidispine.com/schema/vidispine}SearchGroupType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="intervals" type="{http://xml.vidispine.com/schema/vidispine}SearchIntervalsType" minOccurs="0"/>
         <element name="reference" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
         <element name="operator" type="{http://xml.vidispine.com/schema/vidispine}SearchOperatorType" minOccurs="0"/>
         <element name="filter" type="{http://xml.vidispine.com/schema/vidispine}SearchFilterType" maxOccurs="unbounded" minOccurs="0"/>
         <element name="item" type="{http://xml.vidispine.com/schema/vidispine}ItemCriterionType" minOccurs="0"/>
         <element name="shape" type="{http://xml.vidispine.com/schema/vidispine}ShapeCriterionType" minOccurs="0"/>
         <element name="file" type="{http://xml.vidispine.com/schema/vidispine}CriterionType" minOccurs="0"/>
         <element name="facetFilter" maxOccurs="unbounded" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="field" type="{http://www.w3.org/2001/XMLSchema}string"/>
                   <choice>
                     <element name="range" type="{http://xml.vidispine.com/schema/vidispine}FacetRangeType"/>
                     <element name="value" type="{http://www.w3.org/2001/XMLSchema}string"/>
                   </choice>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="facet" maxOccurs="unbounded" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="field" type="{http://www.w3.org/2001/XMLSchema}string"/>
                   <element name="range" type="{http://xml.vidispine.com/schema/vidispine}FacetRangeType" maxOccurs="unbounded" minOccurs="0"/>
                   <element name="exclude" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
                 <attribute name="count" type="{http://www.w3.org/2001/XMLSchema}boolean" default="false" />
                 <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="sort" maxOccurs="unbounded" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="field" type="{http://www.w3.org/2001/XMLSchema}string"/>
                   <element name="order" type="{http://xml.vidispine.com/schema/vidispine}SortingOrderType"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="highlight" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="field" type="{http://www.w3.org/2001/XMLSchema}string" maxOccurs="unbounded" minOccurs="0"/>
                   <element name="matchingOnly" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
                   <element name="prefix" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
                   <element name="suffix" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="suggestion" type="{http://xml.vidispine.com/schema/vidispine}SuggestionSearchType" minOccurs="0"/>
       </sequence>
       <attribute name="version" type="{http://www.w3.org/2001/XMLSchema}int" />
     </restriction>
   </complexContent>
 </complexType>

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ItemSearchType.Facet` Java class for anonymous complex type.
`static class`	`ItemSearchType.FacetFilter` Java class for anonymous complex type.
`static class`	`ItemSearchType.Highlight` Java class for anonymous complex type.
`static class`	`ItemSearchType.Sort` Java class for anonymous complex type.

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<ItemSearchType.Facet>`	`facet`
`protected List<ItemSearchType.FacetFilter>`	`facetFilter`
`protected List<SearchFieldType>`	`field`
`protected CriterionType`	`file`
`protected List<SearchFilterType>`	`filter`
`protected List<SearchGroupType>`	`group`
`protected ItemSearchType.Highlight`	`highlight`
`protected SearchIntervalsType`	`intervals`
`protected ItemCriterionType`	`item`
`protected SearchOperatorType`	`operator`
`protected List<String>`	`reference`
`protected ShapeCriterionType`	`shape`
`protected List<ItemSearchType.Sort>`	`sort`
`protected SuggestionSearchType`	`suggestion`
`protected List<ItemSearchTextValueType>`	`text`
`protected Integer`	`version`

Constructor Summary

Constructors
Constructor and Description

ItemSearchType()

Constructors
Constructor and Description
`ItemSearchType()`

Method Summary

Methods
Modifier and Type	Method and Description
`Object`	`clone()`
`Object`	`copyTo(Object target)`
`Object`	`copyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, Object target, org.jvnet.jaxb2_commons.lang.CopyStrategy strategy)`
`Object`	`createNewInstance()`
`List<ItemSearchType.Facet>`	`getFacet()` Gets the value of the facet property.
`List<ItemSearchType.FacetFilter>`	`getFacetFilter()` Gets the value of the facetFilter property.
`List<SearchFieldType>`	`getField()` Gets the value of the field property.
`CriterionType`	`getFile()` Gets the value of the file property.
`List<SearchFilterType>`	`getFilter()` Gets the value of the filter property.
`List<SearchGroupType>`	`getGroup()` Gets the value of the group property.
`ItemSearchType.Highlight`	`getHighlight()` Gets the value of the highlight property.
`SearchIntervalsType`	`getIntervals()` Gets the value of the intervals property.
`ItemCriterionType`	`getItem()` Gets the value of the item property.
`SearchOperatorType`	`getOperator()` Gets the value of the operator property.
`List<String>`	`getReference()` Gets the value of the reference property.
`ShapeCriterionType`	`getShape()` Gets the value of the shape property.
`List<ItemSearchType.Sort>`	`getSort()` Gets the value of the sort property.
`SuggestionSearchType`	`getSuggestion()` Gets the value of the suggestion property.
`List<ItemSearchTextValueType>`	`getText()` Gets the value of the text property.
`int`	`getVersion()` Gets the value of the version property.
`boolean`	`isSetFacet()`
`boolean`	`isSetFacetFilter()`
`boolean`	`isSetField()`
`boolean`	`isSetFile()`
`boolean`	`isSetFilter()`
`boolean`	`isSetGroup()`
`boolean`	`isSetHighlight()`
`boolean`	`isSetIntervals()`
`boolean`	`isSetItem()`
`boolean`	`isSetOperator()`
`boolean`	`isSetReference()`
`boolean`	`isSetShape()`
`boolean`	`isSetSort()`
`boolean`	`isSetSuggestion()`
`boolean`	`isSetText()`
`boolean`	`isSetVersion()`
`void`	`setFile(CriterionType value)` Sets the value of the file property.
`void`	`setHighlight(ItemSearchType.Highlight value)` Sets the value of the highlight property.
`void`	`setIntervals(SearchIntervalsType value)` Sets the value of the intervals property.
`void`	`setItem(ItemCriterionType value)` Sets the value of the item property.
`void`	`setOperator(SearchOperatorType value)` Sets the value of the operator property.
`void`	`setShape(ShapeCriterionType value)` Sets the value of the shape property.
`void`	`setSuggestion(SuggestionSearchType value)` Sets the value of the suggestion property.
`void`	`setVersion(int value)` Sets the value of the version property.
`void`	`unsetFacet()`
`void`	`unsetFacetFilter()`
`void`	`unsetField()`
`void`	`unsetFilter()`
`void`	`unsetGroup()`
`void`	`unsetReference()`
`void`	`unsetSort()`
`void`	`unsetText()`
`void`	`unsetVersion()`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - text
```
protected List<ItemSearchTextValueType> text
```
  - field
```
protected List<SearchFieldType> field
```
  - group
```
protected List<SearchGroupType> group
```
  - intervals
```
protected SearchIntervalsType intervals
```
  - reference
```
protected List<String> reference
```
  - operator
```
protected SearchOperatorType operator
```
  - filter
```
protected List<SearchFilterType> filter
```
  - item
```
protected ItemCriterionType item
```
  - shape
```
protected ShapeCriterionType shape
```
  - file
```
protected CriterionType file
```
  - facetFilter
```
protected List<ItemSearchType.FacetFilter> facetFilter
```
  - facet
```
protected List<ItemSearchType.Facet> facet
```
  - sort
```
protected List<ItemSearchType.Sort> sort
```
  - highlight
```
protected ItemSearchType.Highlight highlight
```
  - suggestion
```
protected SuggestionSearchType suggestion
```
  - version
```
protected Integer version
```
- Constructor Detail
  - ItemSearchType
```
public ItemSearchType()
```
- Method Detail
  - getText
```
public List<ItemSearchTextValueType> getText()
```
    Gets the value of the text 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 text property.
    For example, to add a new item, do as follows:
```
    getText().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ItemSearchTextValueType
  - isSetText
```
public boolean isSetText()
```
  - unsetText
```
public void unsetText()
```
  - getField
```
public List<SearchFieldType> getField()
```
    Gets the value of the field 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 field property.
    For example, to add a new item, do as follows:
```
    getField().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list SearchFieldType
  - isSetField
```
public boolean isSetField()
```
  - unsetField
```
public void unsetField()
```
  - getGroup
```
public List<SearchGroupType> getGroup()
```
    Gets the value of the group 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 group property.
    For example, to add a new item, do as follows:
```
    getGroup().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list SearchGroupType
  - isSetGroup
```
public boolean isSetGroup()
```
  - unsetGroup
```
public void unsetGroup()
```
  - getIntervals
```
public SearchIntervalsType getIntervals()
```
    Gets the value of the intervals property.
    
    Returns:
    possible object is SearchIntervalsType
  - setIntervals
```
public void setIntervals(SearchIntervalsType value)
```
    Sets the value of the intervals property.
    
    Parameters:
    value - allowed object is SearchIntervalsType
  - isSetIntervals
```
public boolean isSetIntervals()
```
  - getReference
```
public List<String> getReference()
```
    Gets the value of the reference 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 reference property.
    For example, to add a new item, do as follows:
```
    getReference().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list String
  - isSetReference
```
public boolean isSetReference()
```
  - unsetReference
```
public void unsetReference()
```
  - getOperator
```
public SearchOperatorType getOperator()
```
    Gets the value of the operator property.
    
    Returns:
    possible object is SearchOperatorType
  - setOperator
```
public void setOperator(SearchOperatorType value)
```
    Sets the value of the operator property.
    
    Parameters:
    value - allowed object is SearchOperatorType
  - isSetOperator
```
public boolean isSetOperator()
```
  - getFilter
```
public List<SearchFilterType> getFilter()
```
    Gets the value of the filter 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 filter property.
    For example, to add a new item, do as follows:
```
    getFilter().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list SearchFilterType
  - isSetFilter
```
public boolean isSetFilter()
```
  - unsetFilter
```
public void unsetFilter()
```
  - getItem
```
public ItemCriterionType getItem()
```
    Gets the value of the item property.
    
    Returns:
    possible object is ItemCriterionType
  - setItem
```
public void setItem(ItemCriterionType value)
```
    Sets the value of the item property.
    
    Parameters:
    value - allowed object is ItemCriterionType
  - isSetItem
```
public boolean isSetItem()
```
  - getShape
```
public ShapeCriterionType getShape()
```
    Gets the value of the shape property.
    
    Returns:
    possible object is ShapeCriterionType
  - setShape
```
public void setShape(ShapeCriterionType value)
```
    Sets the value of the shape property.
    
    Parameters:
    value - allowed object is ShapeCriterionType
  - isSetShape
```
public boolean isSetShape()
```
  - getFile
```
public CriterionType getFile()
```
    Gets the value of the file property.
    
    Returns:
    possible object is CriterionType
  - setFile
```
public void setFile(CriterionType value)
```
    Sets the value of the file property.
    
    Parameters:
    value - allowed object is CriterionType
  - isSetFile
```
public boolean isSetFile()
```
  - getFacetFilter
```
public List<ItemSearchType.FacetFilter> getFacetFilter()
```
    Gets the value of the facetFilter 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 facetFilter property.
    For example, to add a new item, do as follows:
```
    getFacetFilter().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ItemSearchType.FacetFilter
  - isSetFacetFilter
```
public boolean isSetFacetFilter()
```
  - unsetFacetFilter
```
public void unsetFacetFilter()
```
  - getFacet
```
public List<ItemSearchType.Facet> getFacet()
```
    Gets the value of the facet 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 facet property.
    For example, to add a new item, do as follows:
```
    getFacet().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ItemSearchType.Facet
  - isSetFacet
```
public boolean isSetFacet()
```
  - unsetFacet
```
public void unsetFacet()
```
  - getSort
```
public List<ItemSearchType.Sort> getSort()
```
    Gets the value of the sort 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 sort property.
    For example, to add a new item, do as follows:
```
    getSort().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list ItemSearchType.Sort
  - isSetSort
```
public boolean isSetSort()
```
  - unsetSort
```
public void unsetSort()
```
  - getHighlight
```
public ItemSearchType.Highlight getHighlight()
```
    Gets the value of the highlight property.
    
    Returns:
    possible object is ItemSearchType.Highlight
  - setHighlight
```
public void setHighlight(ItemSearchType.Highlight value)
```
    Sets the value of the highlight property.
    
    Parameters:
    value - allowed object is ItemSearchType.Highlight
  - isSetHighlight
```
public boolean isSetHighlight()
```
  - getSuggestion
```
public SuggestionSearchType getSuggestion()
```
    Gets the value of the suggestion property.
    
    Returns:
    possible object is SuggestionSearchType
  - setSuggestion
```
public void setSuggestion(SuggestionSearchType value)
```
    Sets the value of the suggestion property.
    
    Parameters:
    value - allowed object is SuggestionSearchType
  - isSetSuggestion
```
public boolean isSetSuggestion()
```
  - getVersion
```
public int getVersion()
```
    Gets the value of the version property.
    
    Returns:
    possible object is Integer
  - setVersion
```
public void setVersion(int value)
```
    Sets the value of the version property.
    
    Parameters:
    value - allowed object is Integer
  - isSetVersion
```
public boolean isSetVersion()
```
  - unsetVersion
```
public void unsetVersion()
```
  - clone
```
public Object clone()
```
    Overrides:
    
    clone in class Object
  - copyTo
```
public Object copyTo(Object target)
```
    Specified by:
    
    copyTo in interface org.jvnet.jaxb2_commons.lang.CopyTo
  - copyTo
```
public Object copyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
            Object target,
            org.jvnet.jaxb2_commons.lang.CopyStrategy strategy)
```
    Specified by:
    
    copyTo in interface org.jvnet.jaxb2_commons.lang.CopyTo
  - createNewInstance
```
public Object createNewInstance()
```
    Specified by:
    
    createNewInstance in interface org.jvnet.jaxb2_commons.lang.CopyTo

Class ItemSearchType

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

text

field

group

intervals

reference

operator

filter

item

shape

file

facetFilter

facet

sort

highlight

suggestion

version

Constructor Detail

ItemSearchType

Method Detail

getText

isSetText

unsetText

getField

isSetField

unsetField

getGroup

isSetGroup

unsetGroup

getIntervals

setIntervals

isSetIntervals

getReference

isSetReference

unsetReference

getOperator

setOperator

isSetOperator

getFilter

isSetFilter

unsetFilter

getItem

setItem

isSetItem

getShape

setShape

isSetShape

getFile

setFile

isSetFile

getFacetFilter

isSetFacetFilter

unsetFacetFilter

getFacet

isSetFacet

unsetFacet

getSort

isSetSort

unsetSort

getHighlight

setHighlight

isSetHighlight

getSuggestion

setSuggestion

isSetSuggestion

getVersion

setVersion

isSetVersion

unsetVersion

clone

copyTo

copyTo

createNewInstance