Package de.digitalcollections.model.api.paging

Interface PageRequest

All Known Subinterfaces:
SearchPageRequest
All Known Implementing Classes:
PageRequestImpl, SearchPageRequestImpl
public interface PageRequest
Abstract interface for pagination information. See Spring Data Commons, but more flat design and independent of Spring libraries.

Container for paging, sorting and filtering params:

  • pageNumber: which page to be returned
  • pageSize: how many items on one page
  • sorting: container for sorting order of result list
  • filtering: container for filter criterias of result list

  • Method Details

    • defaultBuilder

      static PageRequest.Builder defaultBuilder()

    • add

      default java.util.List<FilterCriterion> add​(Filtering filtering)
      Add all filter criteria of given filtering to existing filtering. Initialise if no existing filtering.
      Parameters:
      filtering - new filtering criteria to add
      Returns:
      complete filtering

    • first

      PageRequest first()
      Returns:
      the PageRequest requesting the first page

    • setFiltering

      void setFiltering​(Filtering filtering)
      Parameters:
      filtering - the filtering criterias

    • getFiltering

      Filtering getFiltering()
      Returns:
      the filtering parameters

    • getOffset

      int getOffset()
      Returns:
      the offset to be taken according to the underlying page and page size.

    • setPageNumber

      void setPageNumber​(int pageNumber)
      Parameters:
      pageNumber - the page to be returned

    • getPageNumber

      int getPageNumber()
      Returns:
      the page to be returned.

    • setPageSize

      void setPageSize​(int pageSize)
      Parameters:
      pageSize - the number of items of that page

    • getPageSize

      int getPageSize()
      Returns:
      the number of items of that page

    • setSorting

      void setSorting​(Sorting sorting)
      Parameters:
      sorting - the sorting parameters

    • getSorting

      Sorting getSorting()
      Returns:
      the sorting parameters

    • hasPrevious

      boolean hasPrevious()
      Returns whether there's a previous PageRequest we can access from the current one. Will return false in case the current PageRequest already refers to the first page.
      Returns:
      whether there's a previous PageRequest

    • next

      PageRequest next()
      Returns:
      the PageRequest requesting the next page

    • previousOrFirst

      PageRequest previousOrFirst()
      Returns:
      the previous PageRequest or the first PageRequest if the current one already is the first one