Interface Pagination
-
public interface Pagination
Provides services for Paginating resources- Author:
- cdivilly
-
<section role="region">
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
maximumLimit()
Indicates the system wide maximum number of items that a single page may contain.PaginationState
startPagination(javax.servlet.http.HttpServletRequest request, PaginationMetadata pagination)
Determine the maximum number of items that should be included in the representation of the specified request
-
-
<section role="region">
-
Method Detail
-
startPagination
PaginationState startPagination(javax.servlet.http.HttpServletRequest request, PaginationMetadata pagination)
Determine the maximum number of items that should be included in the representation of the specified request- Parameters:
request
- The request for the resourcepagination
- The metadata about how the resource is paginated- Returns:
- The maximum number of items to include in the resource representation
-
maximumLimit
long maximumLimit()
Indicates the system wide maximum number of items that a single page may contain. No paginated resource will ever have more than this number of items. If the maximum number was unbounded, then clients using thelimit
query string parameter could cause a denial of service, by specifying a large value.- Returns:
- The maximum number of items in any page
-
-