Package net.solarnetwork.central.domain

Interface FilterResults<T>

All Superinterfaces:

Iterable<T>

All Known Implementing Classes:

BasicFilterResults

public interface FilterResults<T>
extends Iterable<T>

A filtered query results object.

This object extends Iterable but also exposes a JavaBean getter property getResults() to easy the marshaling of the results into other forms.

Method Summary

Modifier and Type	Method	Description
Iterable<T>	getResults()	Get the actual results.
Integer	getReturnedResultCount()	Get the number of results that matched the query.
Integer	getStartingOffset()	Get the starting offset of the returned results.
Long	getTotalResults()	If available, a total number of results.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

getResults

Iterable<T> getResults()

Get the actual results.

These are the same results returned by Iterable.iterator().

Returns:

the results, never null

getTotalResults

Long getTotalResults()

If available, a total number of results.

Returns:

total results

getStartingOffset

Integer getStartingOffset()

Get the starting offset of the returned results.

Returns:

the starting offset, never null

getReturnedResultCount

Integer getReturnedResultCount()

Get the number of results that matched the query.

Returns:

the number of returned results, never null