Pagination (Apache OODT 0.7 API)

All Known Subinterfaces:

WorkflowInstanceRepository

All Known Implementing Classes:

AbstractPaginatibleInstanceRepository, DataSourceWorkflowInstanceRepository, LuceneWorkflowInstanceRepository, MemoryWorkflowInstanceRepository
```
public interface Pagination
```
Version:

$Revision$
Describe your class here
.

Author:

mattmann

Method Summary

Methods
Modifier and Type	Method and Description
`WorkflowInstancePage`	`getFirstPage()`
`WorkflowInstancePage`	`getLastPage()`
`WorkflowInstancePage`	`getNextPage(WorkflowInstancePage currentPage)`
`WorkflowInstancePage`	`getPagedWorkflows(int pageNum)` Gets the `WorkflowInstancePage` identified by its `pageNum` and associated `status` parameters.
`WorkflowInstancePage`	`getPagedWorkflows(int pageNum, String status)` Gets the `WorkflowInstancePage` identified by its `pageNum` and associated `status` parameters.
`WorkflowInstancePage`	`getPrevPage(WorkflowInstancePage currentPage)`

- Method Detail
  - getFirstPage
```
WorkflowInstancePage getFirstPage()
```
    Returns:
    The first page of products for a particular ProductType.
  - getLastPage
```
WorkflowInstancePage getLastPage()
```
    Returns:
    The last page of products for a particular ProductType.
  - getNextPage
```
WorkflowInstancePage getNextPage(WorkflowInstancePage currentPage)
```
    Parameters:
    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
```
WorkflowInstancePage getPrevPage(WorkflowInstancePage currentPage)
```
    Parameters:
    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.
  - getPagedWorkflows
```
WorkflowInstancePage getPagedWorkflows(int pageNum)
                                       throws InstanceRepositoryException
```
    Gets the WorkflowInstancePage identified by its pageNum and associated status parameters.
    
    Parameters:
    pageNum - The WorkflowInstancePage number to get.
    status - Identifies which WorkflowInstance set to paginate, e.g., only WorkflowInstances with a given status.
    
    Returns:
    The WorkflowInstancePage with the given status, and page number.
    
    Throws:
    
    InstanceRepositoryException - If any error occurs.
  - getPagedWorkflows
```
WorkflowInstancePage getPagedWorkflows(int pageNum,
                                     String status)
                                       throws InstanceRepositoryException
```
    Gets the WorkflowInstancePage identified by its pageNum and associated status parameters.
    
    Parameters:
    pageNum - The WorkflowInstancePage number to get.
    status - Identifies which WorkflowInstance set to paginate, e.g., only WorkflowInstances with a given status.
    
    Returns:
    The WorkflowInstancePage with the given status, and page number.
    
    Throws:
    
    InstanceRepositoryException - If any error occurs.

Interface Pagination

Method Summary

Method Detail

getFirstPage

getLastPage

getNextPage

getPrevPage

getPagedWorkflows

getPagedWorkflows