org.alfresco.query
Interface CannedQueryResults

All Superinterfaces:
PagingResults
All Known Implementing Classes:
EmptyCannedQueryResults

public interface CannedQueryResults
extends PagingResults

Interface for results returned by canned queries.

Since:
4.0

Method Summary
 CannedQuery getOriginatingQuery()
          Get the instance of the query that generated these results.
 int getPageCount()
          Get the number of pages available
 int getPagedResultCount()
          Get the total number of results available within the pages of this result.
 java.util.List getPages()
          Get the paged results
 java.lang.Object 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 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

java.lang.Object 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 getPages()
Get the paged results

Returns:
a list of paged results


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.