Save This Page
Home » displaytag-1.1.1-src » org » displaytag » pagination » [javadoc | source]
org.displaytag.pagination
public interface: PaginatedList [javadoc | source]

All Known Implementing Classes:
    SimplePaginatedList

Interface describing an externally sorted and paginated list.
Method from org.displaytag.pagination.PaginatedList Summary:
getFullListSize,   getList,   getObjectsPerPage,   getPageNumber,   getSearchId,   getSortCriterion,   getSortDirection
Method from org.displaytag.pagination.PaginatedList Detail:
 public int getFullListSize()
    Returns the size of the full list
 public List getList()
    Returns the current partial list
 public 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
 public int getPageNumber()
    Returns the page number of the partial list (starts from 1)
 public 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
 public String getSortCriterion()
    Returns the sort criterion used to externally sort the full list
 public SortOrderEnum getSortDirection()
    Returns the sort direction used to externally sort the full list