Interface PaginationContext


public interface PaginationContext
Describes the requested pagination parameters for a HttpServletRequest. The values encoded in the request's query string (QUERY_FIELDS) are extracted from the HttpServletRequest and represented by this object.
Author:
cdivilly
  • Field Details

  • Method Details

    • itemOffset

      long itemOffset()
      The zero based index offset of the first item to appear in the page
      Returns:
      the index or -1 if no item offset was specified in the request
    • limit

      long limit()
      The requested maximum number of items in the page. Note this value will be clamped to be no greater than the Pagination.maximumLimit() value.
      Returns:
      the requested maximum number of items, or -1 if no limit was specified.
    • modify

      Modify this PaginationContext
      Returns:
      PaginationContext.Builder instance
    • pageOffset

      long pageOffset()
      The zero based page offset
      Returns:
      the page offset or -1 if no page offset was specified in the request