org.apache.oodt.cas.filemgr.util
Interface Pagination

All Known Subinterfaces:

Catalog

All Known Implementing Classes:

DataSourceCatalog, LuceneCatalog, MappedDataSourceCatalog, ScienceDataCatalog

public interface Pagination

Version:

$Revision: 11462 $

An interface for pagination of Product Lists..

Author:

mattmann

Method Summary

ProductPage	getFirstPage(ProductType type)
ProductPage	getLastProductPage(ProductType type)
ProductPage	getNextPage(ProductType type, ProductPage currentPage)
ProductPage	getPrevPage(ProductType type, ProductPage currentPage)

Method Detail

getFirstPage

ProductPage getFirstPage(ProductType type)

Parameters:

type - The ProductType to obtain the first ProductPage for.

Returns:

The first page of products for a particular ProductType.

getLastProductPage

ProductPage getLastProductPage(ProductType type)

Parameters:

type - The ProductType to obtain the last ProductPage for.

Returns:

The last page of products for a particular ProductType.

getNextPage

ProductPage getNextPage(ProductType type,
                        ProductPage currentPage)

Parameters:

type - The ProductType to obtain the next page for, given the currentPage.

currentPage - The current page that tells the function what the next page to obtain is.

Returns:

The next page in the ProductType product list, given the currentPage.

getPrevPage

ProductPage getPrevPage(ProductType type,
                        ProductPage currentPage)

Parameters:

type - The ProductType to obtain the previous page for, given the currentPage.

currentPage - The currentPage that tells the function what the previous page to obtain is.

Returns:

The previous page in the ProductType product list, given the currentPage.