com.yahoo.elide.core.request

Interface Pagination

All Known Implementing Classes:

PaginationImpl

public interface Pagination

Represents a client request to paginate a collection.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_OFFSET Default offset (in records) it client does not provide one.
static int	DEFAULT_PAGE_LIMIT Default page limit (in records) it client does not provide one.
static int	MAX_PAGE_LIMIT Maximum allowable page limit (in records).

Method Summary

Modifier and Type	Method and Description
int	getLimit() Get the page limit.
int	getOffset() Get the page offset.
Long	getPageTotals() Get the total size of the collection.
boolean	isDefaultInstance() Is this the default instance (not present).
boolean	returnPageTotals() Whether or not to fetch the collection size or not.
void	setPageTotals(Long pageTotals) Set the total size of the collection.

Field Detail

DEFAULT_OFFSET

static final int DEFAULT_OFFSET

Default offset (in records) it client does not provide one.

See Also:

Constant Field Values

DEFAULT_PAGE_LIMIT

static final int DEFAULT_PAGE_LIMIT

Default page limit (in records) it client does not provide one.

See Also:

Constant Field Values

MAX_PAGE_LIMIT

static final int MAX_PAGE_LIMIT

Maximum allowable page limit (in records).

See Also:

Constant Field Values

Method Detail

getOffset

int getOffset()

Get the page offset.

Returns:

record offset.

getLimit

int getLimit()

Get the page limit.

Returns:

record limit.

returnPageTotals

boolean returnPageTotals()

Whether or not to fetch the collection size or not.

Returns:

true if the client wants the total size of the collection.

getPageTotals

Long getPageTotals()

Get the total size of the collection.

Returns:

total record count.

setPageTotals

void setPageTotals(Long pageTotals)

Set the total size of the collection.

Parameters:

pageTotals - the total size.

isDefaultInstance

boolean isDefaultInstance()

Is this the default instance (not present).

Returns:

true if pagination wasn't requested. False otherwise.