com.esri.gpt.catalog.search
Interface ISearchFilter

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISearchFilterAuthURI, ISearchFilterContentTypes, ISearchFilterKeyword, ISearchFilterPagination, ISearchFilterSort, ISearchFilterSpatialObj, ISearchFilterTemporal, ISearchFilterThemes, ISearchFilterURI

All Known Implementing Classes:

SearchFilterConnection, SearchFilterContentTypes, SearchFilterHarvestSites, SearchFilterHarvestSpatial, SearchFilterKeyword, SearchFilterPagination, SearchFilterSort, SearchFilterSpatial, SearchFilterTemporal, SearchFilterThemeTypes

public interface ISearchFilter
extends Serializable

The Interface ISearchFilter.defines filters that will be used by the Search Criteria.

Method Summary

SearchParameterMap	getParams() Gets the parameters representing this object to be saved for later restoration.
boolean	isEquals(Object obj) Checks object in argument is equals to this.
void	reset() Resets this object to default properties.
void	setParams(SearchParameterMap parameterMap) Restores this object to the state held by the values in the Parameter map.
void	validate() Checks if object has valid data.

Method Detail

validate

void validate()
              throws SearchException

Checks if object has valid data. Also performs any corrections to the date needed. Should be called at the beginning of the business process stage.

Throws:

SearchException - Exception thrown when none valid data found

reset

void reset()

Resets this object to default properties.

getParams

SearchParameterMap getParams()

Gets the parameters representing this object to be saved for later restoration.

Returns:

object this parameters with restoration values (possibly null)

setParams

void setParams(SearchParameterMap parameterMap)
               throws SearchException

Restores this object to the state held by the values in the Parameter map.

Parameters:

parameterMap - the new parameters for this

Throws:

SearchException - the search exception during error

isEquals

boolean isEquals(Object obj)

Checks object in argument is equals to this.

Parameters:

obj - the obj

Returns:

true, if is equals