io.katharsis.queryParams

Class RequestParams

java.lang.Object

io.katharsis.queryParams.RequestParams

public class RequestParams
extends Object

Contains a set of parameters passed along with the request.

Constructor Summary

Constructors

Constructor and Description
RequestParams(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	getFilters() Contains a set of filters assigned to a request.
List	getGrouping()
List	getIncludedFields()
List<Inclusion>	getIncludedRelations() Get a set of included fields which should be included in the resource
Map<PaginationKeys,Integer>	getPagination()
Map<String,SortingValues>	getSorting() Contains a map of sorting values.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestParams

public RequestParams(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Method Detail

getFilters

public com.fasterxml.jackson.databind.JsonNode getFilters()

Contains a set of filters assigned to a request. Filtering

Returns:

set of filters sent along with the request

getSorting

public Map<String,SortingValues> getSorting()

Contains a map of sorting values. Sorting

Returns:

set of sorting fields assigned to a request

getGrouping

public List getGrouping()

getPagination

public Map<PaginationKeys,Integer> getPagination()

getIncludedFields

public List getIncludedFields()

getIncludedRelations

public List<Inclusion> getIncludedRelations()

Get a set of included fields which should be included in the resource

Returns:

included relationships