com.sage.orion.sdata.servlet
Interface PagingControl

All Known Implementing Classes:

DefaultPagingControl, IndexedPagingControl, KeyedPagingControl

public interface PagingControl

A class that implements the PagingControl interface provides information about which page of a feed is being requested.

Nested Class Summary

static class

PagingControl.PagingMethod

Method Summary

java.lang.Integer	getCount() Gets the number of records to be returned.
SDataConstants.KeyDirection	getKeyDirection() Gets the SDataConstants.KeyDirection for the paging request.
PagingControl.PagingMethod	getMethod() Gets the paging method used.
java.lang.Integer	getStartIndex() Gets the starting index of the first record to be returned.
java.lang.String	getStartKey() Gets the startKey value for paging.
boolean	isLastPage() returns whether this request is for the last page or not.

Method Detail

getStartKey

java.lang.String getStartKey()

Gets the startKey value for paging.

The value returned, if any, is in the SData form, without any surrounding quotes etc. and without any transport-related encoding. However it is still encoded according to the application's method for encoding keys.

Returns:

the startKey value or null if there is no startKey value.

getKeyDirection

SDataConstants.KeyDirection getKeyDirection()

Gets the SDataConstants.KeyDirection for the paging request.

Returns:

the SDataConstants.KeyDirection or null if no keyDirection exists

getStartIndex

java.lang.Integer getStartIndex()

Gets the starting index of the first record to be returned.

Note: This index is 1-based.

Returns:

the starting index (1-based) of the first record to be returned or null if not found.

getCount

java.lang.Integer getCount()

Gets the number of records to be returned.

Returns:

the requested number of records to be returned or null if not found.

isLastPage

boolean isLastPage()

returns whether this request is for the last page or not.

Returns:

true if the lastPage request has been set

getMethod

PagingControl.PagingMethod getMethod()

Gets the paging method used.

Returns:

the PagingControl.PagingMethod used.