Package net.solarnetwork.dao

Interface FilterResults<M extends Identity<K>,K>

Type Parameters:

M - the filtered result type

K - the filtered result identity type

All Superinterfaces:

Iterable<M>

All Known Implementing Classes:

BasicFilterResults

public interface FilterResults<M extends Identity<K>,K>
extends Iterable<M>

A filtered query results object.

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

Since:

1.59

Version:

1.0

Author:

matt

Method Summary

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

getResults

Iterable<M> getResults()

Get the actual results.

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

Returns:

the results, never null

getTotalResults

Long getTotalResults()

Get a total number of available results, if known.

If this result represents partial results and the total count of available results is known, this value represents that total count of available results.

Returns:

total available results, or null if not known

getStartingOffset

int getStartingOffset()

Get the starting offset of the returned results.

Returns:

the starting offset

getReturnedResultCount

int getReturnedResultCount()

Get the number of results that matched the query.

Returns:

the number of returned results