Package de.hybris.platform.b2ctelcofacades.pagination

Interface TmaPaginationFacade

All Known Subinterfaces:

TmaFacetSearchPaginationFacade

All Known Implementing Classes:

DefaultTmaPaginationFacade, FacetSearchTmaPaginationFacade

public interface TmaPaginationFacade

Facade handling operations for pagination.

Since:

1907

Method Summary

Modifier and Type	Method	Description
void	addPaginationHeadersToResponse(org.springframework.util.MultiValueMap<String,String> header, String url, String queryStringWithoutParams, Long totalCount, Integer limit, Integer offset)	Adds the x-total-count and pagination links headers to the response.
Integer	checkLimit(Integer inputLimit)	Method will check if the inputLimit is correct, otherwise it will return a default limit.
Integer	checkOffset(Integer inputOffset)	Method will check if the inputOffset is correct, otherwise it will return a default offset.
<T> List<T>	filterListByOffsetAndLimit(Integer offset, Integer limit, List<T> inputList)	Will filter a list of items(model or dto) by offset and limit.
Integer	getTotalNumberOfPages(Integer noOfItems, Integer limit)	Computes the total number of pages based on the given number of items in total and items per page.

Method Details

getTotalNumberOfPages

Integer getTotalNumberOfPages(Integer noOfItems,
 Integer limit)

Computes the total number of pages based on the given number of items in total and items per page.

Parameters:

noOfItems - the total number of items.

limit - the number of items in a page.

Returns:

the number of pages.

addPaginationHeadersToResponse

void addPaginationHeadersToResponse(org.springframework.util.MultiValueMap<String,String> header,
 String url,
 String queryStringWithoutParams,
 Long totalCount,
 Integer limit,
 Integer offset)

Adds the x-total-count and pagination links headers to the response.

Parameters:

header - The header that will be used in response.

url - The Url of the http request.

queryStringWithoutParams - The url string without the offset and limit params

offset - The offset represents the position in list from where the result list will start.

limit - The limit represents the number of entries that will be selected for the result list.

totalCount - The total number of resources of the requested type that exist in the system.

checkOffset

Integer checkOffset(Integer inputOffset)

Method will check if the inputOffset is correct, otherwise it will return a default offset.

Parameters:

inputOffset - the offset set by the user.

Returns:

inputOffset if input value is correct; 0 otherwise.

checkLimit

Integer checkLimit(Integer inputLimit)

Method will check if the inputLimit is correct, otherwise it will return a default limit.

Parameters:

inputLimit - the limit set by the user.

Returns:

inputLimit if input value is correct; the DEFAULT_LIMIT value from B2ctelcoservicesConstants otherwise.

filterListByOffsetAndLimit

<T> List<T> filterListByOffsetAndLimit(Integer offset,
 Integer limit,
 List<T> inputList)

Will filter a list of items(model or dto) by offset and limit.

Type Parameters:

T - The type of the objects contained in the list.

Parameters:

offset - The offset represents the position in list from where the result list will start.

limit - The limit represents the number of entries that will be selected for the result list.

inputList - The initial list of objects to be filtered.

Returns:

The filtered list.