org.loom.paged
Interface PagedContainer

All Known Subinterfaces:

PagedListCriteria, PagedListData<T>

All Known Implementing Classes:

AbstractPagedContainer, PagedListCriteriaImpl, PagedListDataImpl

public interface PagedContainer

Field Summary

static int

DEFAULT_PAGE_SIZE the default size of each page

Method Summary

java.lang.String	getId()
int	getPageIndex()
int	getPageSize()
int	getRecordIndex()
SortOrder	getSortOrder()
java.lang.String	getSortProperty()

Field Detail

DEFAULT_PAGE_SIZE

static final int DEFAULT_PAGE_SIZE

the default size of each page

See Also:

Constant Field Values

Method Detail

getRecordIndex

int getRecordIndex()

Returns:

the zero-based index of the first record that is returned. Internally, it multiplies the page index and the page size.

getPageIndex

int getPageIndex()

Returns:

the zero-based page index

getSortOrder

SortOrder getSortOrder()

Returns:

the sort order

getSortProperty

java.lang.String getSortProperty()

Returns:

the sort property

getPageSize

int getPageSize()

Returns:

the number of records per page

getId

java.lang.String getId()

Returns:

the id of the paged container. This value will be used to disambiguate if more than one container is used on the same page