Package org.alfresco.query
Interface CannedQueryResults<R>
-
- All Superinterfaces:
PagingResults<R>
- All Known Implementing Classes:
EmptyCannedQueryResults
public interface CannedQueryResults<R> extends PagingResults<R>
Interface for results returned bycanned queries
.- Since:
- 4.0
- Author:
- Derek Hulley, janv
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CannedQuery<R>
getOriginatingQuery()
Get the instance of the query that generated these results.int
getPageCount()
Get the number of pages availableint
getPagedResultCount()
Get the total number of results available within the pages of this result.java.util.List<java.util.List<R>>
getPages()
Get the paged resultsR
getSingleResult()
Get a single result if there is only one result expected.-
Methods inherited from interface org.alfresco.query.PagingResults
getPage, getQueryExecutionId, getTotalResultCount, hasMoreItems
-
-
-
-
Method Detail
-
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:
java.lang.IllegalStateException
- if the query returned more than one result
-
getPages
java.util.List<java.util.List<R>> getPages()
Get the paged results- Returns:
- a list of paged results
-
-