Package com.boomi.connector.api

Class QueryFilter

java.lang.Object

com.boomi.connector.api.QueryFilter

All Implemented Interfaces:

Serializable

public class QueryFilter
extends Object
implements Serializable

Specification for filter to a query operation.

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="expression" type="{}Expression" minOccurs="0"/>
         <element name="sort" type="{}Sort" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static QueryFilter	EMPTY_INSTANCE
protected Expression	expression
protected List<Sort>	sort

Constructor Summary

Constructors

Constructor	Description
QueryFilter()

Method Summary

Modifier and Type	Method	Description
QueryFilter	copy()	Deep copies the fields of the this model into a new instance of this class and returns it.
QueryFilter	copy(boolean isDeep)	Copies the fields of the this model (optionally deeply) into a new instance of this class and returns it.
protected QueryFilter	copy(QueryFilter nobj, boolean isDeep)	Copies the fields of the this model (optionally deeply) into the given instance and returns it.
boolean	equals(Object o)
Expression	getExpression()	Optional expression describing the results desired from the query operation.
List<Sort>	getSort()	Optional sort order for query results.
int	hashCode()
Expression	safeGetExpression()	Returns the current expression property value if non-null, otherwise Expression.EMPTY_INSTANCE.
void	setExpression(Expression value)	Sets the value of the expression property.
String	toString()
QueryFilter	withExpression(Expression newValue)	Sets the expression property to the given newValue and returns this instance.
QueryFilter	withSort(Sort... newValues)	Adds the given newValues to the current sort property List and returns this instance.
QueryFilter	withSort(Collection<? extends Sort> newValues)	Adds the given newValues to the current sort property List and returns this instance.

Methods inherited from class java.lang.Object

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

Field Detail

expression

protected Expression expression

sort

protected List<Sort> sort

EMPTY_INSTANCE

public static final QueryFilter EMPTY_INSTANCE

Constructor Detail

QueryFilter

public QueryFilter()

Method Detail

getExpression

public Expression getExpression()

Optional expression describing the results desired from the query operation. If no expression is given, that implies all objects of the relevant type should be returned.

Returns:

possible object is Expression

setExpression

public void setExpression(Expression value)

Sets the value of the expression property.

Parameters:

value - allowed object is Expression

getSort

public List<Sort> getSort()

Optional sort order for query results. 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 Sort

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

copy

public QueryFilter copy()

Deep copies the fields of the this model into a new instance of this class and returns it.

copy

public QueryFilter copy(boolean isDeep)

Copies the fields of the this model (optionally deeply) into a new instance of this class and returns it.

copy

protected QueryFilter copy(QueryFilter nobj,
                           boolean isDeep)

Copies the fields of the this model (optionally deeply) into the given instance and returns it.

withExpression

public QueryFilter withExpression(Expression newValue)

Sets the expression property to the given newValue and returns this instance.

safeGetExpression

public Expression safeGetExpression()

Returns the current expression property value if non-null, otherwise Expression.EMPTY_INSTANCE.

withSort

public QueryFilter withSort(Sort... newValues)

Adds the given newValues to the current sort property List and returns this instance.

withSort

public QueryFilter withSort(Collection<? extends Sort> newValues)

Adds the given newValues to the current sort property List and returns this instance.