Package org.opencastproject.assetmanager.api.query

Interface AResult

All Superinterfaces:

Iterable<ARecord>

All Known Implementing Classes:

AResultImpl, RichAResult

public interface AResult
extends Iterable<ARecord>

The result of a ASelectQuery. Groups ARecords.

Method Summary

Modifier and Type	Method	Description
long	getLimit()	Return the set's size limit.
long	getOffset()	Return the offset within the total result set.
String	getQuery()	Return a string representation of the query.
LinkedHashSet<ARecord>	getRecords()	Return the found records.
long	getSearchTime()	Return the search time of the query.
long	getSize()	Return the size of the retrieved slice.
long	getTotalSize()	Return the number of items the query could potentially yield.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Method Details

getRecords

LinkedHashSet<ARecord> getRecords()

Return the found records.

getSize

long getSize()

Return the size of the retrieved slice. This value is <= getLimit().

See Also:

• getLimit()

getQuery

String getQuery()

Return a string representation of the query.

getTotalSize

long getTotalSize()

Return the number of items the query could potentially yield.

Returns:

the total value or -1 to indicate that the value has not been calculated

getLimit

long getLimit()

Return the set's size limit. It reflects the requested page size if specified in the query. This value is >= getSize().

Returns:

the requested size limit or -1 if none has been specified

See Also:

• getSize()

getOffset

long getOffset()

Return the offset within the total result set.

getSearchTime

long getSearchTime()

Return the search time of the query.

Returns:

the search time or -1 to indicate that it has not been measured