com.elasticpath.domain.catalogview.search
Interface SearchRequest

All Superinterfaces:

CatalogViewRequest, EpDomain, java.io.Serializable, Transient

All Known Implementing Classes:

SearchRequestImpl

public interface SearchRequest
extends CatalogViewRequest

Represents a search request.

Nested Class Summary

Nested classes/interfaces inherited from interface com.elasticpath.domain.catalogview.CatalogViewRequest

CatalogViewRequest.FilterQueryString

Method Summary

java.lang.String	getEncodedKeyWords() Returns the url-encoded key words.
java.lang.String	getKeyWords() Returns the keywords specified in the search request.
boolean	isFuzzySearchDisabled() Returns whether or not a fuzzy search should be performed for this query.
void	setFuzzySearchDisabled(boolean fuzzySearchDisabled) Sets whether or not a fuzzy search should be performed for this query.
void	setKeyWords(java.lang.String keyWords) Sets the keywords.

Methods inherited from interface com.elasticpath.domain.catalogview.CatalogViewRequest

addFilter, compare, filterProducts, getCategoryUid, getCurrency, getFilterIds, getFilterQueryStrings, getFilters, getLocale, getMaxReturnNumber, getQueryString, getSorter, getSorterFactory, setCategoryUid, setCurrency, setFiltersIdStr, setLocale, setMaxReturnNumber, setSorterIdStr

Methods inherited from interface com.elasticpath.domain.EpDomain

getElasticPath, setElasticPath

Method Detail

getEncodedKeyWords

java.lang.String getEncodedKeyWords()

Returns the url-encoded key words.

Returns:

the url-encoded key words.

getKeyWords

java.lang.String getKeyWords()

Returns the keywords specified in the search request.

Returns:

the keywords

isFuzzySearchDisabled

boolean isFuzzySearchDisabled()

Returns whether or not a fuzzy search should be performed for this query.

Returns:

true if fuzzy search is disabled, false otherwise

setFuzzySearchDisabled

void setFuzzySearchDisabled(boolean fuzzySearchDisabled)

Sets whether or not a fuzzy search should be performed for this query.

Parameters:

fuzzySearchDisabled - whether or not fuzzy search is disabled

setKeyWords

void setKeyWords(java.lang.String keyWords)
                 throws EpCatalogViewRequestBindException

Sets the keywords.

Parameters:

keyWords - the keywords to set

Throws:

EpCatalogViewRequestBindException - in case the given keywords is invalid