com.flowthings.client

Class QueryOptions

java.lang.Object

com.flowthings.client.QueryOptions

public class QueryOptions
extends Object

When making a DomainObjectApi.find(QueryOptions) request, use QueryOptions to specify:

• The Filter String, for restricting the result set returned
• The number of records to skip
• A limit to the number of records returned
• The order in which to sort the results

For examples, see HTTP Flow Find

Author:

matt

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BATCH_SIZE
static int	DEFAULT_LIMIT_SIZE
protected String	filter
protected Integer	limit
static int	NO_LIMIT
protected Integer	skip
protected Map<String,SortType>	sorts

Constructor Summary

Constructors

Constructor and Description
QueryOptions()

Method Summary

Modifier and Type	Method and Description
QueryOptions	filter(String filterStr) For defining the parameters of the search
QueryOptions	limit(int ct) To limit the number of results returned
QueryOptions	skip(int ct) The number of records from the beginning which we shall skip
QueryOptions	sort(String sort, SortType sortType) The order in which to sort the results
Map<String,String>	toMap()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

See Also:

Constant Field Values

DEFAULT_LIMIT_SIZE

public static final int DEFAULT_LIMIT_SIZE

See Also:

Constant Field Values

NO_LIMIT

public static final int NO_LIMIT

See Also:

Constant Field Values

sorts

protected Map<String,SortType> sorts

skip

protected Integer skip

limit

protected Integer limit

filter

protected String filter

Constructor Detail

QueryOptions

public QueryOptions()

Method Detail

sort

public QueryOptions sort(String sort,
                         SortType sortType)

The order in which to sort the results

Parameters:

sort - - a field to sort by

sortType - - order of the sort

Returns:

- this

skip

public QueryOptions skip(int ct)

The number of records from the beginning which we shall skip

Parameters:

ct - - number of records to skip

Returns:

- this

limit

public QueryOptions limit(int ct)

To limit the number of results returned

Parameters:

ct - - the number of results returned (default 20)

Returns:

- this

filter

public QueryOptions filter(String filterStr)

For defining the parameters of the search

Parameters:

filterStr - - flowthings filter language

Returns:

- this

toMap

public Map<String,String> toMap()