com.plumtree.uiinfrastructure.pagination
Interface IPaginationRO

All Known Subinterfaces:

IBaseSearchResultModelRO, ISearchResultModelRO

All Known Implementing Classes:

SavedSearchPortletModel, SearchResultModel

public interface IPaginationRO

Author:

CraigS General interface for pagination (read-only part).

Method Summary

int	GetFirstDisplayableItem() Returns the index of the first displayable item.
int	GetItemsPerPage() Returns the user's desired results per page.
int	GetNumDisplayableItems() Returns the number of results actually returned.
java.lang.String	GetSortOrder() Returns the current sort order.
int	GetTotalItems() Returns the total number of items, some of which may not currently be displayable.

Method Detail

GetFirstDisplayableItem

int GetFirstDisplayableItem()

Returns the index of the first displayable item. On the first page of results, this will be 1; on subsequent pages it will be 11, 21, and so on (if there are 10 items per page).

GetItemsPerPage

int GetItemsPerPage()

Returns the user's desired results per page. This may differ from the number of currently displayable items if the total number of items is short or if the user is looking at the last page. or if the user is looking at the last result page.

GetNumDisplayableItems

int GetNumDisplayableItems()

Returns the number of results actually returned.

GetSortOrder

java.lang.String GetSortOrder()

Returns the current sort order.

GetTotalItems

int GetTotalItems()

Returns the total number of items, some of which may not currently be displayable.