org.alfresco.query

Class ListBackedPagingResults

java.lang.Object

org.alfresco.query.ListBackedPagingResults

All Implemented Interfaces:

PagingResults

public class ListBackedPagingResults
extends java.lang.Object
implements PagingResults

Wraps a list of items as a PagingResults, used typically when migrating from a full listing system to a paged one.

Since:

Odin

Constructor Summary

Constructors

Constructor and Description
ListBackedPagingResults(java.util.List list)
ListBackedPagingResults(java.util.List list, PagingRequest paging)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	getPage() Returns the whole set of results as one page
java.lang.String	getQueryExecutionId() There is no unique query ID, as no query was done
Pair	getTotalResultCount() We know exactly how many results there are
boolean	hasMoreItems() True if more items on next page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ListBackedPagingResults

public ListBackedPagingResults(java.util.List list)

ListBackedPagingResults

public ListBackedPagingResults(java.util.List list,
                       PagingRequest paging)

Method Detail

getPage

public java.util.List getPage()

Returns the whole set of results as one page

Specified by:

getPage in interface PagingResults

Returns:

the results - possibly empty but never null

hasMoreItems

public boolean hasMoreItems()

Description copied from interface: PagingResults

True if more items on next page.

Note: could also return true if page was cutoff/trimmed for some reason (eg. due to permission checks of large page of requested max items)

Specified by:

hasMoreItems in interface PagingResults

Returns:

true if more items (eg. on next page)
- true => at least one more page (or incomplete page - if cutoff)
- false => last page (or incomplete page - if cutoff)

getTotalResultCount

public Pair getTotalResultCount()

We know exactly how many results there are

Specified by:

getTotalResultCount in interface PagingResults

Returns:

Returns the total results as a range (all results, including the paged results returned)

getQueryExecutionId

public java.lang.String getQueryExecutionId()

There is no unique query ID, as no query was done

Specified by:

getQueryExecutionId in interface PagingResults

Returns:

a unique ID associated with the query execution results