org.unitedinternet.cosmo.model.filter

Class PageCriteria<SortType extends Enum>

java.lang.Object

org.unitedinternet.cosmo.model.filter.PageCriteria<SortType>

public class PageCriteria<SortType extends Enum>
extends Object

This class defines the criteria for pagination. Holds the Page Number, Page Size, Sort Type and Sort Order

Author:

EdBindl, Travis Vachon

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASCENDING_STRING Value representing ascending sort order in URLs.
static int	DEFAULT_PAGENUMBER The Default Page Number
static int	DEFAULT_PAGESIZE The Default Pagesize
static Boolean	DEFAULT_SORTASCENDING The Default sort ascending
static String	DESCENDING_STRING Value representing descending sort order in URLs.
static int	FIRST_PAGE
static String	PAGE_NUMBER_URL_KEY Key for page number in URLs.
static String	PAGE_SIZE_URL_KEY Key for page size in URLs.
static String	QUERY_URL_KEY Key for query in URLs.
static String	SORT_ORDER_URL_KEY Key for sort order in URLs.
static String	SORT_TYPE_URL_KEY Key for sort type in URLs.
static int	VIEW_ALL The constant to view all.

Constructor Summary

Constructors

Constructor and Description
PageCriteria()
PageCriteria(Integer pageNumber, Integer pageSize, boolean sortAscending, SortType sortType)

Method Summary

Modifier and Type	Method and Description
void	addOr(String key, String value)
Set<String[]>	getOrCriteria()
int	getPageNumber()
int	getPageSize()
String	getSortOrder()
SortType	getSortType()
String	getSortTypeString()
void	initialize()
boolean	isSortAscending()
void	setPageNumber(int pageNumber)
void	setPageSize(int pageSize)
void	setSortAscending(boolean sortOrder)
void	setSortType(SortType sortType)

Methods inherited from class java.lang.Object

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

Field Detail

VIEW_ALL

public static final int VIEW_ALL

The constant to view all.

See Also:

Constant Field Values

DEFAULT_PAGENUMBER

public static final int DEFAULT_PAGENUMBER

The Default Page Number

See Also:

Constant Field Values

DEFAULT_PAGESIZE

public static final int DEFAULT_PAGESIZE

The Default Pagesize

See Also:

Constant Field Values

DEFAULT_SORTASCENDING

public static final Boolean DEFAULT_SORTASCENDING

The Default sort ascending

FIRST_PAGE

public static final int FIRST_PAGE

See Also:

Constant Field Values

ASCENDING_STRING

public static final String ASCENDING_STRING

Value representing ascending sort order in URLs.

See Also:

Constant Field Values

DESCENDING_STRING

public static final String DESCENDING_STRING

Value representing descending sort order in URLs.

See Also:

Constant Field Values

PAGE_SIZE_URL_KEY

public static final String PAGE_SIZE_URL_KEY

Key for page size in URLs.

See Also:

Constant Field Values

PAGE_NUMBER_URL_KEY

public static final String PAGE_NUMBER_URL_KEY

Key for page number in URLs.

See Also:

Constant Field Values

SORT_ORDER_URL_KEY

public static final String SORT_ORDER_URL_KEY

Key for sort order in URLs.

See Also:

Constant Field Values

SORT_TYPE_URL_KEY

public static final String SORT_TYPE_URL_KEY

Key for sort type in URLs.

See Also:

Constant Field Values

QUERY_URL_KEY

public static final String QUERY_URL_KEY

Key for query in URLs.

See Also:

Constant Field Values

Constructor Detail

PageCriteria

public PageCriteria()

PageCriteria

public PageCriteria(Integer pageNumber,
                    Integer pageSize,
                    boolean sortAscending,
                    SortType sortType)

Method Detail

addOr

public void addOr(String key,
                  String value)

getOrCriteria

public Set<String[]> getOrCriteria()

getPageNumber

public int getPageNumber()

setPageNumber

public void setPageNumber(int pageNumber)

getPageSize

public int getPageSize()

setPageSize

public void setPageSize(int pageSize)

getSortType

public SortType getSortType()

getSortTypeString

public String getSortTypeString()

setSortType

public void setSortType(SortType sortType)

isSortAscending

public boolean isSortAscending()

Returns:

true for Ascending and false for Descending

setSortAscending

public void setSortAscending(boolean sortOrder)

Parameters:

sortOrder - Set to true for Ascending and false for Descending

getSortOrder

public String getSortOrder()

initialize

public void initialize()