com.sage.orion.sdata.servlet
Class IndexedPagingControl

java.lang.Object
  com.sage.orion.sdata.servlet.DefaultPagingControl
      com.sage.orion.sdata.servlet.IndexedPagingControl

All Implemented Interfaces:

PagingControl

public final class IndexedPagingControl
extends DefaultPagingControl

A structure to hold the elements of any indexed paging control request.

This holds the paging information as Objects rather than primitives, with null references used if they were not specified.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sage.orion.sdata.servlet.PagingControl

PagingControl.PagingMethod

Method Summary

PagingControl.PagingMethod	getMethod() Gets the paging method used.
java.lang.Integer	getStartIndex() Gets the starting index of the first record to be returned.
boolean	isLastPage() returns whether this request is for the last page or not.

Methods inherited from class com.sage.orion.sdata.servlet.DefaultPagingControl

getCount, getKeyDirection, getStartKey

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getStartIndex

public java.lang.Integer getStartIndex()

Description copied from interface: PagingControl

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

Note: This index is 1-based.

Specified by:

getStartIndex in interface PagingControl

Overrides:

getStartIndex in class DefaultPagingControl

Returns:

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

isLastPage

public boolean isLastPage()

Description copied from interface: PagingControl

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

Specified by:

isLastPage in interface PagingControl

Overrides:

isLastPage in class DefaultPagingControl

Returns:

true if the lastPage request has been set

getMethod

public PagingControl.PagingMethod getMethod()

Description copied from interface: PagingControl

Gets the paging method used.

Specified by:

getMethod in interface PagingControl

Overrides:

getMethod in class DefaultPagingControl

Returns:

the PagingControl.PagingMethod used.