org.ikasan.framework.management.search
Interface PagedSearchResult<T>

All Superinterfaces:

Collection<T>, Iterable<T>, List<T>

All Known Implementing Classes:

ArrayListPagedSearchResult

public interface PagedSearchResult<T>
extends List<T>

This class is intended to be used as a DTO for transporting a subset of search results for some domain object from a larger set of searched results. This is intended to support paging. For example we may be performing a search for some domain entities that would return 1000 results if not paged. For performance and usability reasons, a search result of 1000 entries may not be desired. This class allows for sub result set to be returned, including enough information to establish its position within the superset, as well as the size of the super set

Author:

Ikasan Development Team

Method Summary

int	getFirstResultIndex() Accessor for first result index
long	getResultSize() Accessor for resultSize
boolean	isLastPage()

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

getFirstResultIndex

int getFirstResultIndex()

Accessor for first result index

Returns:

index of the first result shown here into the larger super set of results

isLastPage

boolean isLastPage()

Returns:

true if this represents the last page in the super result set

getResultSize

long getResultSize()

Accessor for resultSize

Returns:

size of the larger super result set