com.yahoo.bard.webservice.util

Interface Pagination<T>

Type Parameters:

T - Type of things being paginated

All Superinterfaces:

Serializable

All Known Implementing Classes:

AllPagesPagination, SinglePagePagination

public interface Pagination<T>
extends Serializable

Interface for pagination.

Field Summary

Fields

Modifier and Type	Field and Description
static int	FIRST_PAGE
static long	serialVersionUID

Method Summary

Modifier and Type	Method and Description
OptionalInt	getFirstPage() Gets the number of the first page if this is not the current page.
OptionalInt	getLastPage() Gets the number of the last page if this is not the current page.
OptionalInt	getNextPage() Gets next page if it exists.
int	getNumResults() Get the size of all the data.
int	getPage() Gets the number of the current page.
List<T>	getPageOfData() Get a list of results corresponding to the current page of data.
int	getPerPage() Gets the maximum size of a page.
OptionalInt	getPreviousPage() Gets previous page if it exists.

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

FIRST_PAGE

static final int FIRST_PAGE

See Also:

Constant Field Values

Method Detail

getPage

int getPage()

Gets the number of the current page.

Returns:

The current page

getPerPage

int getPerPage()

Gets the maximum size of a page.

Returns:

The maximum page size

getFirstPage

OptionalInt getFirstPage()

Gets the number of the first page if this is not the current page.

Returns:

The first page

getLastPage

OptionalInt getLastPage()

Gets the number of the last page if this is not the current page.

Returns:

The last page

getNextPage

OptionalInt getNextPage()

Gets next page if it exists.

Returns:

The next page

getPreviousPage

OptionalInt getPreviousPage()

Gets previous page if it exists.

Returns:

The previous page

getPageOfData

List<T> getPageOfData()

Get a list of results corresponding to the current page of data.

Returns:

The List of paginated results

getNumResults

int getNumResults()

Get the size of all the data.

Returns:

The data size