de.hybris.platform.webservicescommons.pagination

Interface WebPaginationUtils

All Known Implementing Classes:

DefaultWebPaginationUtils

public interface WebPaginationUtils

Utility class for creating pagination info from web request parameters

Method Summary

Modifier and Type	Method and Description
PaginationWsDTO	buildPagination(SearchResult<?> search) Extracts PaginationWsDTO form data in provided SearchResult.
int	getCurrentPage(Map<String,String> params) Returns current page from map of (request) parameters.
int	getDefaultPageSize() Returns default page size
int	getPageSize(Map<String,String> params) Returns page size from map of (request) parameters.
int	getPageSize(Map<String,String> params, int defaultValue) Returns page size from map of (request) parameters.
int	getStartPosition(Map<String,String> params) Calculates start position for paginated search using vales in map of (request) parameters.
int	getStartPosition(Map<String,String> params, int defaultPageSize) Calculates start position for paginated search using vales in map of (request) parameters.

Method Detail

getPageSize

int getPageSize(Map<String,String> params)

Returns page size from map of (request) parameters. Uses WebservicescommonsConstants.PAGE_SIZE as key.

Parameters:

params - map of parameters

Returns:

page size for current request

getPageSize

int getPageSize(Map<String,String> params,
                int defaultValue)

Returns page size from map of (request) parameters. Uses WebservicescommonsConstants.PAGE_SIZE as key. If not found returns given default.

Parameters:

params - map of parameters

defaultValue - default page size

Returns:

page size for current request

getDefaultPageSize

int getDefaultPageSize()

Returns default page size

Returns:

default page size

getCurrentPage

int getCurrentPage(Map<String,String> params)

Returns current page from map of (request) parameters. Uses WebservicescommonsConstants.CURRENT_PAGE as key.

Parameters:

params - map of parameters

Returns:

current page number

getStartPosition

int getStartPosition(Map<String,String> params)

Calculates start position for paginated search using vales in map of (request) parameters.

Parameters:

params - map of parameters

Returns:

start position for query in current request

getStartPosition

int getStartPosition(Map<String,String> params,
                     int defaultPageSize)

Calculates start position for paginated search using vales in map of (request) parameters. Uses provided defaultPageSize instead of system one in case of not finding page size in provided params.

Parameters:

params - map of parameters

defaultPageSize - default page size

Returns:

start position for query in current request

buildPagination

PaginationWsDTO buildPagination(SearchResult<?> search)

Extracts PaginationWsDTO form data in provided SearchResult.

Parameters:

search - SearchResult used to create PaginationWsDTO

Returns:

Pagination data