io.coodoo.framework.listing.boundary

Class ListingParameters

java.lang.Object

io.coodoo.framework.listing.boundary.ListingParameters

public class ListingParameters
extends Object

Listing query parameters and settings

Author:

coodoo GmbH (coodoo.io)

Constructor Summary

Constructors

Constructor and Description
ListingParameters()
ListingParameters(Integer page, Integer limit, String sortAttribute)

Method Summary

Modifier and Type	Method and Description
void	addFilterAttributes(String attribute, String value) Adds a filter to a specific attribute
String	getFilter()
Map<String,String>	getFilterAttributes()
Integer	getIndex()
Integer	getLimit()
Integer	getPage()
ListingPredicate	getPredicate()
String	getSortAttribute()
javax.ws.rs.core.UriInfo	getUriInfo()
void	setFilter(String filter)
void	setIndex(Integer index)
void	setLimit(Integer limit)
void	setPage(Integer page)
void	setPredicate(ListingPredicate predicate)
void	setSortAttribute(String sortAttribute)
void	setUriInfo(javax.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Detail

ListingParameters

public ListingParameters()

ListingParameters

public ListingParameters(Integer page,
                         Integer limit,
                         String sortAttribute)

Parameters:

page - number for pagination

limit - of results per page for pagination

sortAttribute - name of the attribute the result list gets sorted by

Method Detail

getIndex

public Integer getIndex()

Returns:

index for pagination (position in whole list where current pagination page starts)

setIndex

public void setIndex(Integer index)

Parameters:

index - for pagination (position in whole list where current pagination page starts)

getPage

public Integer getPage()

Returns:

page number for pagination

setPage

public void setPage(Integer page)

Parameters:

page - number for pagination

getLimit

public Integer getLimit()

Returns:

limit of results per page for pagination

setLimit

public void setLimit(Integer limit)

Parameters:

limit - of results per page for pagination (use 0 to get the whole list)

getSortAttribute

public String getSortAttribute()

Returns:

name of the attribute the result list gets sorted by (prefix '+' for ascending (default) or '-' for descending order. E.g. '-creationDate')

setSortAttribute

public void setSortAttribute(String sortAttribute)

Parameters:

sortAttribute - name of the attribute the result list gets sorted by (prefix '+' for ascending (default) or '-' for descending order. E.g. '-creationDate')

getFilter

public String getFilter()

Returns:

global filter string that is applied to all attributes

setFilter

public void setFilter(String filter)

Parameters:

filter - global filter string that is applied to all attributes (use ListingFilterIgnore on an attribute in the target entity to spare it out)

addFilterAttributes

public void addFilterAttributes(String attribute,
                                String value)

Adds a filter to a specific attribute

Parameters:

attribute - attribute name

value - filter value

getFilterAttributes

public Map<String,String> getFilterAttributes()

Returns:

Map of attribute specific filters

getPredicate

public ListingPredicate getPredicate()

Returns:

root of custom filter condition tree

setPredicate

public void setPredicate(ListingPredicate predicate)

Parameters:

predicate - root of custom filter condition tree

getUriInfo

public javax.ws.rs.core.UriInfo getUriInfo()

setUriInfo

public void setUriInfo(javax.ws.rs.core.UriInfo uriInfo)