Class CannedQueryPageDetails


  • public class CannedQueryPageDetails
    extends java.lang.Object
    Details for canned queries supporting paged results.

    Results are skipped, chopped into pages of appropriate size before the start page and number are returned.

    Since:
    4.0
    Author:
    Derek Hulley
    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
      • getSkipResults

        public int getSkipResults()
        Get the number of query results to skip before applying further page parameters
        Returns:
        results to skip before page one
      • getPageSize

        public int getPageSize()
        Get the size of each page
        Returns:
        the size of each page
      • getPageNumber

        public int getPageNumber()
        Get the first page number to return
        Returns:
        the first page number to return
      • getPageCount

        public int getPageCount()
        Get the total number of pages to return
        Returns:
        the number of pages to return
      • getResultsRequiredForPaging

        public int getResultsRequiredForPaging()
        Calculate the number of results that would be required to satisy this paging request. Note that the skip size can significantly increase this number even if the page sizes are small.
        Returns:
        the number of results required for proper paging