org.hdpagination.core
Class Globals

java.lang.Object
  org.hdpagination.core.Globals

public final class Globals
extends java.lang.Object

Class where some constants used by framework internally (e.g. request parameter of no of page to access) are defined.

Since:

1.0

Author:

Liangfeng Ren

Field Summary

static java.lang.String	APPLICATION_SCOPE Indicating the search result is saved in Application scope
static int	DEFAULT_PAGE_SIZE The default records displayed in one page
static java.lang.String	ERROR_MESSAGE The name of attribute holding ErrorMessages instance when validation fails
static java.lang.String	ORDER_BY_ASCENDING_PARAM The name of request parameter indicating whether the search result should be sorted in ascending or descending order.
static java.lang.String	ORDER_BY_PARAM The name of request parameter indicating the column by which search result should be sorted from Sort Pagination Control
static java.lang.String	PAGE The name of attribute holding Page instance in Session scope
static java.lang.String	PAGE_NO_PARAM The name of request parameter indicating which page (starting from 0) to access from Pagination Control(e.g.
static java.lang.String	PAGE_SIZE_PARAM The default name of request parameter representing page size (number of records per page).
static java.lang.String	PAGINATION_ACTION_ID The name of request parameter indicating action id from all Pagination Control (e.g.
static java.lang.String	PAGING_URL URL indicating the request is from Pagination Control
static java.lang.String	QUERY_RESULT_KEY The default name of attribute which holds the search result in Session, Request or Application scope
static java.lang.String	REQUEST_SCOPE Indicating the search result is saved in Request scope
static java.lang.String	SESSION_SCOPE Indicating the search result is saved in Session scope
static java.lang.String	VIEW_SCOPE Indicating the search result is saved in view scope (only supported since JSF 2.0)

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_NO_PARAM

public static final java.lang.String PAGE_NO_PARAM

The name of request parameter indicating which page (starting from 0) to access from Pagination Control(e.g. page navigation link, page link, pages dropdown etc)

See Also:

Constant Field Values

ORDER_BY_PARAM

public static final java.lang.String ORDER_BY_PARAM

The name of request parameter indicating the column by which search result should be sorted from Sort Pagination Control

See Also:

Constant Field Values

ORDER_BY_ASCENDING_PARAM

public static final java.lang.String ORDER_BY_ASCENDING_PARAM

The name of request parameter indicating whether the search result should be sorted in ascending or descending order. "true" means ascending order and "false" means descending order.

See Also:

Constant Field Values

PAGE_SIZE_PARAM

public static final java.lang.String PAGE_SIZE_PARAM

The default name of request parameter representing page size (number of records per page).

Since:

1.2

See Also:

Constant Field Values

PAGINATION_ACTION_ID

public static final java.lang.String PAGINATION_ACTION_ID

The name of request parameter indicating action id from all Pagination Control (e.g. page navigation link, page link, pages dropdown etc)

See Also:

Constant Field Values

QUERY_RESULT_KEY

public static final java.lang.String QUERY_RESULT_KEY

The default name of attribute which holds the search result in Session, Request or Application scope

See Also:

Constant Field Values

PAGE

public static final java.lang.String PAGE

The name of attribute holding Page instance in Session scope

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

The default records displayed in one page

See Also:

Constant Field Values

REQUEST_SCOPE

public static final java.lang.String REQUEST_SCOPE

Indicating the search result is saved in Request scope

See Also:

Constant Field Values

SESSION_SCOPE

public static final java.lang.String SESSION_SCOPE

Indicating the search result is saved in Session scope

See Also:

Constant Field Values

APPLICATION_SCOPE

public static final java.lang.String APPLICATION_SCOPE

Indicating the search result is saved in Application scope

See Also:

Constant Field Values

VIEW_SCOPE

public static final java.lang.String VIEW_SCOPE

Indicating the search result is saved in view scope (only supported since JSF 2.0)

See Also:

Constant Field Values

PAGING_URL

public static final java.lang.String PAGING_URL

URL indicating the request is from Pagination Control

See Also:

Constant Field Values

ERROR_MESSAGE

public static final java.lang.String ERROR_MESSAGE

The name of attribute holding ErrorMessages instance when validation fails

See Also:

Constant Field Values