com.crystaldecisions.sdk.occa.infostore
Interface IPagingQueryBase

All Known Subinterfaces:

ICategoryPager, IFolderPager, IPagingQuery

public interface IPagingQueryBase

This interface defines a paging scheme that manages the number of search results that are displayed per page and the number of pages allowed in a range.

Method Summary

int	getCurrPageNumber() Gets the current page number.
int	getItemsPerPage() Gets the number of objects in a page.
int	getPagesPerRange() Gets the number of pages in a range.
int	getRangeFirstPageNumber() Gets the first page number in the current range.
int	getRangeLastPageNumber() Gets the last page number in the current range.
boolean	hasNextPage() Gets a boolean that determines whether the IPagingQueryBase object has a next page.
boolean	hasNextRange() Gets a boolean that determines whether the IPagingQueryBase object has a succeeding range.
boolean	hasPrevPage() Gets a boolean that determines whether the IPagingQueryBase object has a previous page.
boolean	hasPrevRange() Gets a boolean that determines whether the IPagingQueryBase object has a preceding range.
void	moveToFirstPage() Moves to the first page of the query set.
void	moveToLastPage() Moves to the last page of the query set.
void	moveToNextPage() Moves to the next page.
void	moveToNextRange() Moves to the succeeding range.
void	moveToPreviousPage() Moves to the previous page in the query set.
void	moveToPreviousRange() Moves to the preceding range.
void	setCurrPageNumber(int val) Sets the current page number.
void	setItemsPerPage(int lNum) Sets the number of objects in a page.
void	setPagesPerRange(int lNum) Sets the number of pages in a range.

Method Detail

getItemsPerPage

public int getItemsPerPage()

Gets the number of objects in a page.

Returns:

The int number of items that are allowed per page.

setItemsPerPage

public void setItemsPerPage(int lNum)
                     throws SDKException

Sets the number of objects in a page.

Parameters:

lNum - The int that limits the number of objects per page.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getPagesPerRange

public int getPagesPerRange()

Gets the number of pages in a range.

Returns:

The int number of pages for a given range.

setPagesPerRange

public void setPagesPerRange(int lNum)
                      throws SDKException

Sets the number of pages in a range.

Parameters:

lNum - The int that limits the number of pages per range.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCurrPageNumber

public int getCurrPageNumber()
                      throws SDKException

Gets the current page number.

Returns:

The current page number as an int.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setCurrPageNumber

public void setCurrPageNumber(int val)
                       throws SDKException

Sets the current page number.

Parameters:

val - The int that sets the current page number.

Throws:

SDKException - This is thrown if the process is unsuccessful.

hasPrevPage

public boolean hasPrevPage()
                    throws SDKException

Gets a boolean that determines whether the IPagingQueryBase object has a previous page.

Returns:

true if there is a previous page, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

hasNextPage

public boolean hasNextPage()
                    throws SDKException

Gets a boolean that determines whether the IPagingQueryBase object has a next page.

Returns:

true if there is a next page, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

hasPrevRange

public boolean hasPrevRange()
                     throws SDKException

Gets a boolean that determines whether the IPagingQueryBase object has a preceding range.

Returns:

true if there is a preceding range, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

hasNextRange

public boolean hasNextRange()
                     throws SDKException

Gets a boolean that determines whether the IPagingQueryBase object has a succeeding range.

Returns:

true if there is a succeeding range, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getRangeFirstPageNumber

public int getRangeFirstPageNumber()
                            throws SDKException

Gets the first page number in the current range.

Returns:

The number of the first page in the current range as an int.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getRangeLastPageNumber

public int getRangeLastPageNumber()
                           throws SDKException

Gets the last page number in the current range.

Returns:

The number of the last page in the current range as an int.

Throws:

SDKException - This is thrown if the process is unsuccessful.

moveToFirstPage

public void moveToFirstPage()
                     throws SDKException

Moves to the first page of the query set.

Throws:

SDKException - This is thrown if the process is unsuccessful.

moveToLastPage

public void moveToLastPage()
                    throws SDKException

Moves to the last page of the query set.

Throws:

SDKException - This is thrown if the process is unsuccessful.

moveToPreviousPage

public void moveToPreviousPage()
                        throws SDKException

Moves to the previous page in the query set.

Throws:

SDKException - This is thrown if the process is unsuccessful.

moveToNextPage

public void moveToNextPage()
                    throws SDKException

Moves to the next page.

Throws:

SDKException - This is thrown if the process is unsuccessful.

moveToPreviousRange

public void moveToPreviousRange()
                         throws SDKException

Moves to the preceding range.

Throws:

SDKException - This is thrown if the process is unsuccessful.

moveToNextRange

public void moveToNextRange()
                     throws SDKException

Moves to the succeeding range.

Throws:

SDKException - This is thrown if the process is unsuccessful.