Package com.testdroid.api.dto

Class Context<T extends APIEntity>

java.lang.Object

com.testdroid.api.dto.Context<T>

public class Context<T extends APIEntity>
extends Object

Author:

Damian Sniezek <[email protected]>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_LIMIT
static final int	DEFAULT_OFFSET
static final String	FILTER_DELIMITER
static final String	FILTER_REQUEST_PARAM
static final String	GROUP_REQUEST_PARAM
static final String	LIMIT_REQUEST_PARAM
static final String	OFFSET_REQUEST_PARAM
static final String	SEARCH_REQUEST_PARAM
static final String	SORT_REQUEST_PARAM

Constructor Summary

Constructors

Constructor	Description
Context(Class<T> type)
Context(Class<T> type, int offset, int limit, String search, String sort)
Context(Class<T> type, int offset, int limit, String search, String sort, List<FilterEntry> filters, List<String> groups)

Method Summary

Modifier and Type	Method	Description
Context<T>	addFilter(FilterEntry filterEntry)
<R extends T> Context<R>	as(Class<R> clazz)
org.apache.commons.collections4.MultiValuedMap<String,Object>	build()
Optional<Integer>	computeMaxResult()
Optional<FilterEntry>	findFilter(String field, Operand operand)
Optional<APISort.SortItem>	findSort(String field)
Boolean	getCacheable()
org.apache.commons.collections4.MultiValuedMap<String,Object>	getExtraParams()
List<FilterEntry>	getFilters()
List<String>	getGroups()
int	getLimit()
int	getOffset()
String	getSearch()
APISort	getSort()
Class<T>	getType()
Context<T>	setCacheable(Boolean cacheable)
Context<T>	setCount(Long count)
void	setExtraParams(org.apache.commons.collections4.MultiValuedMap<String,Object> extraParams)
Context<T>	setFilters(List<FilterEntry> filters)
Context<T>	setLimit(int limit)
Context<T>	setOffset(int offset)
Context<T>	setSearch(String search)
Context<T>	setSort(APISort sort)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LIMIT

public static final int DEFAULT_LIMIT

See Also:

• Constant Field Values

DEFAULT_OFFSET

public static final int DEFAULT_OFFSET

See Also:

• Constant Field Values

FILTER_REQUEST_PARAM

public static final String FILTER_REQUEST_PARAM

See Also:

• Constant Field Values

SEARCH_REQUEST_PARAM

public static final String SEARCH_REQUEST_PARAM

See Also:

• Constant Field Values

FILTER_DELIMITER

public static final String FILTER_DELIMITER

See Also:

• Constant Field Values

GROUP_REQUEST_PARAM

public static final String GROUP_REQUEST_PARAM

See Also:

• Constant Field Values

LIMIT_REQUEST_PARAM

public static final String LIMIT_REQUEST_PARAM

See Also:

• Constant Field Values

SORT_REQUEST_PARAM

public static final String SORT_REQUEST_PARAM

See Also:

• Constant Field Values

OFFSET_REQUEST_PARAM

public static final String OFFSET_REQUEST_PARAM

See Also:

• Constant Field Values

Constructor Details

Context

public Context(Class<T> type)

Context

public Context(Class<T> type,
 int offset,
 int limit,
 String search,
 String sort)

Context

public Context(Class<T> type,
 int offset,
 int limit,
 String search,
 String sort,
 List<FilterEntry> filters,
 List<String> groups)

Method Details

getOffset

public int getOffset()

setOffset

public Context<T> setOffset(int offset)

getLimit

public int getLimit()

setLimit

public Context<T> setLimit(int limit)

getSearch

public String getSearch()

setSearch

public Context<T> setSearch(String search)

getSort

public APISort getSort()

findSort

public Optional<APISort.SortItem> findSort(String field)

setSort

public Context<T> setSort(APISort sort)

getType

public Class<T> getType()

getFilters

public List<FilterEntry> getFilters()

findFilter

public Optional<FilterEntry> findFilter(String field,
 Operand operand)

setFilters

public Context<T> setFilters(List<FilterEntry> filters)

addFilter

public Context<T> addFilter(FilterEntry filterEntry)

getGroups

public List<String> getGroups()

getCacheable

public Boolean getCacheable()

setCacheable

public Context<T> setCacheable(Boolean cacheable)

getExtraParams

public org.apache.commons.collections4.MultiValuedMap<String,Object> getExtraParams()

setExtraParams

public void setExtraParams(org.apache.commons.collections4.MultiValuedMap<String,Object> extraParams)

setCount

public Context<T> setCount(Long count)

computeMaxResult

public Optional<Integer> computeMaxResult()

build

public org.apache.commons.collections4.MultiValuedMap<String,Object> build()

as

public <R extends T> Context<R> as(Class<R> clazz)