com.whitestein.lsps.common.query

Class PagingCriteria

java.lang.Object

com.whitestein.lsps.common.query.PagingCriteria

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

LogCriteria, ModelInstanceCriteria, ModuleCriteria, OrderingAndPagingCriteria, PersonCriteria, RollbackInfoCriteria, SavedDocumentCriteria, TodoCriteria, TodoListCriteria, WsRequestHandlerCriteria

public class PagingCriteria
extends Object
implements Serializable

A basic criteria object supporting paged results.

Author:

mhi

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PagingCriteria.DynamicOrdering

Constructor Summary

Constructors

Constructor and Description
PagingCriteria() Default constructor with paging OFF.
PagingCriteria(int count) Constructor with paging ON and given result count.
PagingCriteria(int index, int count) Constructor with paging ON and given index and result count.

Method Summary

Modifier and Type	Method and Description
int	getCount() Returns the count of items in the result list.
Ordering<String>	getDynamicOrdering()
List<Filter>	getFilters() Returns list of filters applied to result list.
int	getIndex() Returns the index of the first item in the result list (starting from 0).
boolean	isPaged() Returns true if the query should return only a part of the result list.
void	setCount(int count) Sets the count of items in the result list.
void	setDynamicOrdering(String column, boolean ascending)
void	setFilters(List<Filter> filters) Sets filters that are applied to result list.
void	setIndex(int index) Sets the index of the first item in the result list (starting from 0).

Methods inherited from class java.lang.Object

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

Constructor Detail

PagingCriteria

public PagingCriteria()

Default constructor with paging OFF.

PagingCriteria

public PagingCriteria(int count)

Constructor with paging ON and given result count.

Parameters:

count -

PagingCriteria

public PagingCriteria(int index,
                      int count)

Constructor with paging ON and given index and result count.

Parameters:

index -

count -

Method Detail

isPaged

public final boolean isPaged()

Returns true if the query should return only a part of the result list. This is in fact a shorthand for getCount() > 0.

Returns:

true if the query should return only a part of the result

getIndex

public final int getIndex()

Returns the index of the first item in the result list (starting from 0). If paging is off, returns 0.

Returns:

index

setIndex

public final void setIndex(int index)

Sets the index of the first item in the result list (starting from 0).

Parameters:

index -

getCount

public final int getCount()

Returns the count of items in the result list. If count <= 0, query should return all results.

Returns:

count of items in the result list

setCount

public final void setCount(int count)

Sets the count of items in the result list. If count <= 0, query should return all results.

Parameters:

count -

getFilters

public List<Filter> getFilters()

Returns list of filters applied to result list.

Returns:

filters

setFilters

public void setFilters(List<Filter> filters)

Sets filters that are applied to result list.

Parameters:

filters -

getDynamicOrdering

public Ordering<String> getDynamicOrdering()

setDynamicOrdering

public void setDynamicOrdering(String column,
                               boolean ascending)