Interface CannedQueryResults<R>

All Superinterfaces:
PagingResults<R>
All Known Implementing Classes:
EmptyCannedQueryResults

public interface CannedQueryResults<R> extends PagingResults<R>
Interface for results returned by canned queries.
Since:
4.0
Author:
Derek Hulley, janv
  • Method Details

    • getOriginatingQuery

      CannedQuery<R> getOriginatingQuery()
      Get the instance of the query that generated these results.
      Returns:
      the query that generated these results.
    • getPagedResultCount

      int getPagedResultCount()
      Get the total number of results available within the pages of this result. The count excludes results chopped out by the paging process i.e. it is only the count of results physically obtainable through this instance.
      Returns:
      number of results available in the pages
    • getPageCount

      int getPageCount()
      Get the number of pages available
      Returns:
      the number of pages available
    • getSingleResult

      R getSingleResult()
      Get a single result if there is only one result expected.
      Returns:
      a single result
      Throws:
      IllegalStateException - if the query returned more than one result
    • getPages

      List<List<R>> getPages()
      Get the paged results
      Returns:
      a list of paged results