oracle.webcenter.portal.persistence

Class PageNumberPagination

java.lang.Object

oracle.webcenter.portal.persistence.PageNumberPagination

All Implemented Interfaces:

PaginationRule

public class PageNumberPagination
extends java.lang.Object
implements PaginationRule

This class represents a restriction on a query run against the persistence layer, indicating which page of a result set should be returned, and how large each page should be. Instances of this class should be used to restrict the number and set of results returns by a query, especially when those results are intended to be displayed in the UI. The first page is page 1.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SIZE

Constructor Summary

Constructors

Constructor and Description
PageNumberPagination(int pageNo) Constructor specifying the page number, using the default page size of 25.
PageNumberPagination(int pageNo, int pageSize) Constructor specifying both page number and page size.

Method Summary

Modifier and Type	Method and Description
int	getFirstResultIndex() Get the absolute index of the first result on this page
int	getRowLimit() Get the maximum number of rows to return

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SIZE

public static final int DEFAULT_SIZE

See Also:

Constant Field Values

Constructor Detail

PageNumberPagination

public PageNumberPagination(int pageNo,
                            int pageSize)

Constructor specifying both page number and page size.

Parameters:

pageNo - The ordinal number of the page of results to return (starts from 1)

pageSize - The size (in number of results) of each page

PageNumberPagination

public PageNumberPagination(int pageNo)

Constructor specifying the page number, using the default page size of 25.

Parameters:

pageNo - The ordinal number of the page of results to return (starts from 1)

Method Detail

getFirstResultIndex

public int getFirstResultIndex()

Get the absolute index of the first result on this page

Specified by:

getFirstResultIndex in interface PaginationRule

getRowLimit

public int getRowLimit()

Get the maximum number of rows to return

Specified by:

getRowLimit in interface PaginationRule