com.esri.gpt.catalog.search
Class SearchFilterPagination

java.lang.Object
  com.esri.gpt.framework.request.PageCursor
      com.esri.gpt.catalog.search.SearchFilterPagination

All Implemented Interfaces:

ISearchFilter, ISearchFilterPagination, IPageCursor, Serializable

public class SearchFilterPagination
extends PageCursor
implements ISearchFilterPagination

The Class SearchFilterPagination. Filter for controlling page navigation.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.esri.gpt.framework.request.PageCursor

PageCursor.DefaultRecordsPerPageProvider, PageCursor.IRecordsPerPageProvider

Field Summary

Fields inherited from class com.esri.gpt.framework.request.PageCursor

_currentPage, _pagesPerCursor, _recordsPerPageProvider, _totalRecordCount

Constructor Summary

SearchFilterPagination()
Instantiates a new search filter pagination.

Method Summary

void	checkCurrentPage() Check current page.
boolean	equals(Object obj)
SearchParameterMap	getParams() Gets the params.
int	getRecordsPerPage() Gets the records per page.
int	getStartPosition() Gets the start position.
boolean	isEquals(Object obj) Checks if object in argument is equal to this
void	reset() Reset.
void	setParams(SearchParameterMap parameterMap) Sets the params.
void	setRecordsPerPage(int resultsPerPage) Sets the records per page.
void	setStartPostion(int startPosition) Sets the start position.
String	toString()
void	validate() Validate.

Methods inherited from class com.esri.gpt.framework.request.PageCursor

getCurrentPage, getEndPage, getEndRecord, getHasNextPage, getHasPreviousPage, getNextPage, getPagesPerCursor, getPreviousPage, getStartPage, getStartRecord, getTotalPageCount, getTotalRecordCount, setCurrentPage, setPagesPerCursor, setRecordsPerPageProvider, setTotalRecordCount

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.gpt.framework.request.IPageCursor

getCurrentPage, getEndPage, getEndRecord, getHasNextPage, getHasPreviousPage, getNextPage, getPagesPerCursor, getPreviousPage, getStartPage, getStartRecord, getTotalPageCount, getTotalRecordCount, setCurrentPage, setPagesPerCursor, setRecordsPerPageProvider, setTotalRecordCount

Constructor Detail

SearchFilterPagination

public SearchFilterPagination()

Instantiates a new search filter pagination.

Method Detail

getRecordsPerPage

public int getRecordsPerPage()

Gets the records per page.

Specified by:

getRecordsPerPage in interface IPageCursor

Overrides:

getRecordsPerPage in class PageCursor

Returns:

the results per page

setRecordsPerPage

public void setRecordsPerPage(int resultsPerPage)

Sets the records per page.

Specified by:

setRecordsPerPage in interface IPageCursor

Overrides:

setRecordsPerPage in class PageCursor

Parameters:

resultsPerPage - the new results per page

setStartPostion

public void setStartPostion(int startPosition)

Sets the start position.

getStartPosition

public int getStartPosition()

Gets the start position.

Returns:

the start position

getParams

public SearchParameterMap getParams()

Gets the params.

Specified by:

getParams in interface ISearchFilter

Returns:

Map with parameters (never null)

See Also:

ISearchFilter.getParams()

setParams

public void setParams(SearchParameterMap parameterMap)

Sets the params.

Specified by:

setParams in interface ISearchFilter

Parameters:

parameterMap - the parameter map

See Also:

ISearchFilter.setParams(com.esri.gpt.catalog.search.SearchParameterMap)

reset

public void reset()

Reset.

Specified by:

reset in interface ISearchFilter

See Also:

ISearchFilter.reset()

validate

public void validate()
              throws SearchException

Validate.

Specified by:

validate in interface ISearchFilter

Throws:

SearchException - the search exception

See Also:

ISearchFilter.validate()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj - Object for comparison

Returns:

true if object is equal to this

isEquals

public boolean isEquals(Object obj)

Checks if object in argument is equal to this

Specified by:

isEquals in interface ISearchFilter

Parameters:

obj -

Returns:

true if equal, false otherwise

toString

public String toString()

Overrides:

toString in class Object

Returns:

String representation

checkCurrentPage

public void checkCurrentPage()

Check current page.

Specified by:

checkCurrentPage in interface IPageCursor

Overrides:

checkCurrentPage in class PageCursor