com.esri.gpt.framework.request
Interface IPageCursor

All Known Subinterfaces:

ISearchFilterPagination

All Known Implementing Classes:

PageCursor, SearchFilterPagination

public interface IPageCursor

The Interface IPageCursor.

Method Summary

void	checkCurrentPage() Check current page.
int	getCurrentPage() Gets the current page for the cursor.
int	getEndPage() Gets the ending page for the cursor.
int	getEndRecord() Gets the ending record for the current page.
boolean	getHasNextPage() Determine if the cursor has a next page.
boolean	getHasPreviousPage() Determine if the cursor has a previous page.
int	getNextPage() Gets the next page.
int	getPagesPerCursor() Gets the maximum number of pages to be displayed per cursor.
int	getPreviousPage() Gets the previous page.
int	getRecordsPerPage() Gets the maximum number of records to be displayed per page.
int	getStartPage() Gets the starting page for the cursor.
int	getStartRecord() Gets the starting record for the current page.
int	getTotalPageCount() Gets the total page count.
int	getTotalRecordCount() Gets the total record count.
void	setCurrentPage(int currentPage) Sets the current page for the cursor.
void	setPagesPerCursor(int pagesPerCursor) Sets the maximum number of pages to be displayed per cursor.
void	setRecordsPerPage(int recordsPerPage) Sets the maximum number of records to be displayed per page.
void	setRecordsPerPageProvider(PageCursor.IRecordsPerPageProvider recordsPerPageProvider) Sets records per page provider.
void	setTotalRecordCount(int totalRecordCount) Sets the total record count.

Method Detail

getCurrentPage

int getCurrentPage()

Gets the current page for the cursor.

Returns:

the current page

setCurrentPage

void setCurrentPage(int currentPage)

Sets the current page for the cursor.

Parameters:

currentPage - the current page

getEndPage

int getEndPage()

Gets the ending page for the cursor.

Returns:

the ending page

getEndRecord

int getEndRecord()

Gets the ending record for the current page.

Returns:

the ending record

getHasNextPage

boolean getHasNextPage()

Determine if the cursor has a next page.

Returns:

true if the cursor has a next page

getHasPreviousPage

boolean getHasPreviousPage()

Determine if the cursor has a previous page.

Returns:

true if the cursor has a previous page

getNextPage

int getNextPage()

Gets the next page.

Returns:

the next page

getPagesPerCursor

int getPagesPerCursor()

Gets the maximum number of pages to be displayed per cursor.

Returns:

the maximum number of pages per cursor

setPagesPerCursor

void setPagesPerCursor(int pagesPerCursor)

Sets the maximum number of pages to be displayed per cursor.

Parameters:

pagesPerCursor - the maximum number of pages per cursor

getPreviousPage

int getPreviousPage()

Gets the previous page.

Returns:

the previous page

getRecordsPerPage

int getRecordsPerPage()

Gets the maximum number of records to be displayed per page.

Returns:

the maximum number of records per page

setRecordsPerPage

void setRecordsPerPage(int recordsPerPage)

Sets the maximum number of records to be displayed per page.

Parameters:

recordsPerPage - the maximum number of records per page

setRecordsPerPageProvider

void setRecordsPerPageProvider(PageCursor.IRecordsPerPageProvider recordsPerPageProvider)

Sets records per page provider.

Parameters:

recordsPerPageProvider - records per page provider

getStartPage

int getStartPage()

Gets the starting page for the cursor.

Returns:

the starting page

getStartRecord

int getStartRecord()

Gets the starting record for the current page.

Returns:

the starting record

getTotalPageCount

int getTotalPageCount()

Gets the total page count.

The total page count is based upon the total record count and the number of records per page.

Returns:

the total page count

getTotalRecordCount

int getTotalRecordCount()

Gets the total record count.

This is the total record count associated with a query. It is used in conjunction with recordsPerPage to determine the number of pages available to the cursor.

Returns:

the total record count

setTotalRecordCount

void setTotalRecordCount(int totalRecordCount)

Sets the total record count.

This is the total record count associated with a query. It is used in conjunction with recordsPerPage to determine the number of pages available to the cursor.

Parameters:

totalRecordCount - the total record count

checkCurrentPage

void checkCurrentPage()

Check current page.