org.killbill.billing.util.entity

Interface Pagination<T>

Type Parameters:

T - type of record, usually an Entity

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, java.lang.Iterable<T>

public interface Pagination<T>
extends java.lang.Iterable<T>, java.io.Closeable

Represents a page, i.e. a subset, of records

The Pagination object will be associated with a database connection. You must iterate through all results to close the connection.

Method Summary

Modifier and Type	Method and Description
java.lang.Long	getCurrentOffset()
java.lang.Long	getMaxNbRecords() Total number of records in the complete data set, regardless of paging and filtering The implementation doesn't have to guarantee accuracy.
java.lang.Long	getNextOffset()
java.lang.Long	getTotalNbRecords() Total number of records in the data set, regardless of paging, but including filtering The implementation doesn't have to guarantee accuracy.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface java.io.Closeable

close

Method Detail

getCurrentOffset

java.lang.Long getCurrentOffset()

Returns:

offset from which these records are returned

getNextOffset

java.lang.Long getNextOffset()

Returns:

offset to use to retrieve the next set of records, null if this is the last page of records

getMaxNbRecords

java.lang.Long getMaxNbRecords()

Total number of records in the complete data set, regardless of paging and filtering

The implementation doesn't have to guarantee accuracy.

Returns:

total number of records (approximation), null if unknown

getTotalNbRecords

java.lang.Long getTotalNbRecords()

Total number of records in the data set, regardless of paging, but including filtering

The implementation doesn't have to guarantee accuracy.

Returns:

total number of records (approximation), null if unknown