org.apache.oodt.cas.filemgr.structs

Class ProductPage

java.lang.Object

org.apache.oodt.cas.filemgr.structs.ProductPage

public class ProductPage
extends Object

Version:

$Revision$

A Page of Products returned from the File Manager.

Author:

mattmann, bfoster

Constructor Summary

Constructors

Constructor and Description
ProductPage() Default Constructor
ProductPage(int pageNum, int totalPages, int pageSize, List<Product> pageProducts)

Method Summary

Modifier and Type	Method and Description
static ProductPage	blankPage()
long	getNumOfHits()
int	getPageNum()
List<Product>	getPageProducts()
int	getPageSize()
int	getTotalPages()
boolean	isFirstPage()
boolean	isLastPage()
void	setNumOfHits(long numOfHits)
void	setPageNum(int pageNum)
void	setPageProducts(List<Product> pageProducts)
void	setPageSize(int pageSize)
void	setTotalPages(int totalPages)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProductPage

public ProductPage()

Default Constructor

.

ProductPage

public ProductPage(int pageNum,
                   int totalPages,
                   int pageSize,
                   List<Product> pageProducts)

Parameters:

pageNum - The number of this page.

totalPages - The total number of pages in the set.

pageSize - The size of this page.

pageProducts - The products associated with this page.

Method Detail

getPageNum

public int getPageNum()

Returns:

Returns the pageNum.

setPageNum

public void setPageNum(int pageNum)

Parameters:

pageNum - The pageNum to set.

getPageProducts

public List<Product> getPageProducts()

Returns:

Returns the pageProducts.

setPageProducts

public void setPageProducts(List<Product> pageProducts)

Parameters:

pageProducts - The pageProducts to set.

getPageSize

public int getPageSize()

Returns:

Returns the pageSize.

setPageSize

public void setPageSize(int pageSize)

Parameters:

pageSize - The pageSize to set.

getTotalPages

public int getTotalPages()

Returns:

Returns the totalPages.

setTotalPages

public void setTotalPages(int totalPages)

Parameters:

totalPages - The totalPages to set.

isLastPage

public boolean isLastPage()

Returns:

True if this is the last page in the set, false otherwise.

isFirstPage

public boolean isFirstPage()

Returns:

True if this is the fist page of the set, false otherwise.

getNumOfHits

public long getNumOfHits()

Returns:

the numOfHits

setNumOfHits

public void setNumOfHits(long numOfHits)

Parameters:

numOfHits - the numOfHits to set

blankPage

public static ProductPage blankPage()

Returns:

A blank, unpopulated ProductPage.