org.displaytag.pagination
Interface PaginatedList

public interface PaginatedList

Interface describing an externally sorted and paginated list.

Author:

JBN

Method Summary

int	getFullListSize() Returns the size of the full list
java.util.List	getList() Returns the current partial list
int	getObjectsPerPage() Returns the number of objects per page.
int	getPageNumber() Returns the page number of the partial list (starts from 1)
java.lang.String	getSearchId() Returns an ID for the search used to get the list.
java.lang.String	getSortCriterion() Returns the sort criterion used to externally sort the full list
SortOrderEnum	getSortDirection() Returns the sort direction used to externally sort the full list

Method Detail

getList

java.util.List getList()

Returns the current partial list

Returns:

the current partial list

getPageNumber

int getPageNumber()

Returns the page number of the partial list (starts from 1)

Returns:

the page number of the partial list

getObjectsPerPage

int getObjectsPerPage()

Returns the number of objects per page. Unless this page is the last one the partial list should thus have a size equal to the result of this method

Returns:

the number of objects per page

getFullListSize

int getFullListSize()

Returns the size of the full list

Returns:

the size of the full list

getSortCriterion

java.lang.String getSortCriterion()

Returns the sort criterion used to externally sort the full list

Returns:

the sort criterion used to externally sort the full list

getSortDirection

SortOrderEnum getSortDirection()

Returns the sort direction used to externally sort the full list

Returns:

the sort direction used to externally sort the full list

getSearchId

java.lang.String getSearchId()

Returns an ID for the search used to get the list. It may be null. Such an ID can be necessary if the full list is cached, in a way or another (in the session, in the business tier, or anywhere else), to be able to retrieve the full list from the cache

Returns:

the search ID