com.rallydev.rest.util

Class QueryFilter

java.lang.Object

com.rallydev.rest.util.QueryFilter

All Implemented Interfaces:

Cloneable

public class QueryFilter
extends Object
implements Cloneable

Represents a query filter to be applied to query requests.

More on the WSAPI query syntax can be found here: http://rally1.rallydev.com/slm/doc/webservice

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryFilter(QueryFilter left, String operator, QueryFilter right) Internal constructor for joining multiple QueryFilter objects by an AND or OR.
	QueryFilter(String field, String operator, String value) Create a new query filter with the specified options.

Method Summary

Modifier and Type	Method and Description
static QueryFilter	and(QueryFilter... queryFilters) Get a query filter that is the ANDed combination of the specified filters.
QueryFilter	and(QueryFilter q) Get a query filter that is the ANDed combination of this filter and the specified one.
static QueryFilter	or(QueryFilter... queryFilters) Get a query filter that is the ORed combination of the specified filters.
QueryFilter	or(QueryFilter q) Get a query filter that is the ORed combination of this filter and the specified one.
String	toString() Get the string representation of this query filter.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryFilter

public QueryFilter(String field,
                   String operator,
                   String value)

Create a new query filter with the specified options.

Parameters:

field - the object field to evaluate

operator - the operator to use for evaluation

value - the value to be evaluated

QueryFilter

protected QueryFilter(QueryFilter left,
                      String operator,
                      QueryFilter right)

Internal constructor for joining multiple QueryFilter objects by an AND or OR.

Parameters:

left - the left query

operator - AND/OR

right - the right query

Method Detail

and

public QueryFilter and(QueryFilter q)

Get a query filter that is the ANDed combination of this filter and the specified one.

Parameters:

q - the filter to be ANDed

Returns:

the ANDed query filter

or

public QueryFilter or(QueryFilter q)

Get a query filter that is the ORed combination of this filter and the specified one.

Parameters:

q - the filter to be ORed

Returns:

the ORed query filter

toString

public String toString()

Get the string representation of this query filter.

Examples:

• (ScheduleState = Accepted)
• ((ScheduleState = Accepted) AND (Iteration.Name = "My Iteration"))

Overrides:

toString in class Object

Returns:

the string representation of this query filter.

and

public static QueryFilter and(QueryFilter... queryFilters)

Get a query filter that is the ANDed combination of the specified filters.

Parameters:

queryFilters - one or more query filters to be ANDed together

Returns:

the ANDed query filter

or

public static QueryFilter or(QueryFilter... queryFilters)

Get a query filter that is the ORed combination of the specified filters.

Parameters:

queryFilters - one or more query filters to be ORed together

Returns:

the ORed query filter