de.hybris.platform.adaptivesearch.context

Interface AsSearchProfileContext

All Known Implementing Classes:

DefaultAsSearchProfileContext

public interface AsSearchProfileContext

This interface represents a context used for search profile related operations.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getAttributes() Returns a Map instance that can be used to store attributes.
java.util.List<CatalogVersionModel>	getCatalogVersions() Returns the catalog versions.
java.util.List<CategoryModel>	getCategoryPath() Returns the category path.
CurrencyModel	getCurrency() Returns the currency.
java.lang.String	getIndexConfiguration() Returns the index configuration.
java.lang.String	getIndexType() Returns the index type.
java.util.List<AsKeyword>	getKeywords() Returns the keywords.
LanguageModel	getLanguage() Returns the language.
java.lang.String	getQuery() Returns the query.
java.util.List<CatalogVersionModel>	getSessionCatalogVersions() Returns the session catalog versions.
void	setKeywords(java.util.List<AsKeyword> keywords) Sets the keywords.
void	setQuery(java.lang.String query) Sets the query.

Method Detail

getIndexConfiguration

java.lang.String getIndexConfiguration()

Returns the index configuration.

Returns:

the index configuration

getIndexType

java.lang.String getIndexType()

Returns the index type.

Returns:

the index type

getCatalogVersions

java.util.List<CatalogVersionModel> getCatalogVersions()

Returns the catalog versions.

Returns:

the catalog versions

getSessionCatalogVersions

java.util.List<CatalogVersionModel> getSessionCatalogVersions()

Returns the session catalog versions. Sometimes the search query runs in a local session context which sets the catalog versions in the session to the ones used in the search query, for this reason this method should be used instead of CatalogVersionService.getSessionCatalogVersions().

Returns:

the session catalog versions

getCategoryPath

java.util.List<CategoryModel> getCategoryPath()

Returns the category path.

Returns:

the category path

getLanguage

LanguageModel getLanguage()

Returns the language.

Returns:

the language

getCurrency

CurrencyModel getCurrency()

Returns the currency.

Returns:

the currency

getKeywords

java.util.List<AsKeyword> getKeywords()

Returns the keywords.

Returns:

the keywords

setKeywords

void setKeywords(java.util.List<AsKeyword> keywords)

Sets the keywords.

Parameters:

keywords - - the keywords

getQuery

java.lang.String getQuery()

Returns the query.

Returns:

the query

setQuery

void setQuery(java.lang.String query)

Sets the query.

Parameters:

query - - the query

getAttributes

java.util.Map<java.lang.String,java.lang.Object> getAttributes()

Returns a Map instance that can be used to store attributes.

Returns:

the map containing the attributes