com.esri.gpt.catalog.search
Class SearchFilterSort

java.lang.Object
  com.esri.gpt.catalog.search.SearchFilterSort

All Implemented Interfaces:

ISearchFilter, ISearchFilterSort, Serializable

public class SearchFilterSort
extends Object
implements ISearchFilterSort

The Class SearchFilterSort.

See Also:

Serialized Form

Nested Class Summary

static class

SearchFilterSort.OptionsSort The Enum OptionsSort.

Constructor Summary

SearchFilterSort()
Instantiates a new search filter sort.

Method Summary

boolean	equals(Object obj)
SearchParameterMap	getParams() Dehydrates this object into a map
String	getSelectedSort() Gets the user selected sort method.
boolean	isEquals(Object obj) Checks if object in argument is equal to this
void	reset() Resets the class to its default values
void	setParams(SearchParameterMap parameterMap) Hydrates the object from the parameterMap
void	setSelectedSort(String selectedSort) Sets the selected sort method.
String	toString()
void	validate() Checks if object has valid data.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchFilterSort

public SearchFilterSort()

Instantiates a new search filter sort.

Method Detail

getSelectedSort

public String getSelectedSort()

Gets the user selected sort method.

Specified by:

getSelectedSort in interface ISearchFilterSort

Returns:

the selected sort (trimmed, never null, default = "relevance")

setSelectedSort

public void setSelectedSort(String selectedSort)

Sets the selected sort method.

Specified by:

setSelectedSort in interface ISearchFilterSort

Parameters:

selectedSort - the new selected sort (if not one of OptionsSort, warning generated and parameter ignored (can be null).

getParams

public SearchParameterMap getParams()

Dehydrates this object into a map

Specified by:

getParams in interface ISearchFilter

Returns:

map with this field parameters to be stored

setParams

public void setParams(SearchParameterMap parameterMap)

Hydrates the object from the parameterMap

Specified by:

setParams in interface ISearchFilter

Parameters:

parameterMap -

reset

public void reset()

Resets the class to its default values

Specified by:

reset in interface ISearchFilter

validate

public void validate()
              throws SearchException

Description copied from interface: ISearchFilter

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.

Specified by:

validate in interface ISearchFilter

Throws:

SearchException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Parameters:

obj -

Returns:

true if equal, false otherwise

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 of object