Package org.kiwiproject.search

Interface PaginatedResult

public interface PaginatedResult
Simple interface defining basic pagination for any kind of search, e.g. a database query, SOLR search, etc.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageNumber()
    The page number of this result.
    int
    getPageSize()
    The page size being used to paginate the search results.
    long
    getTotalCount()
    The total number of results, though a PaginatedResult instance will contain only a subset of the total.

  • Method Details

    • getTotalCount

      long getTotalCount()
      The total number of results, though a PaginatedResult instance will contain only a subset of the total.
      Returns:
      total number of results

    • getPageNumber

      int getPageNumber()
      The page number of this result. Can be used in both zero- and one-based page numbering schemes as long as it is used consistently, e.g. the server and clients are both using one-based page numbering.
      Returns:
      the page number

    • getPageSize

      int getPageSize()
      The page size being used to paginate the search results.
      Returns:
      the page size