de.hybris.platform.solrfacetsearch.search.context

Interface FacetSearchContext

All Known Implementing Classes:

DefaultFacetSearchContext

public interface FacetSearchContext

This interface represents a context valid for the duration of a search.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FacetSearchContext.Status

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<IndexedTypeSort>	getAvailableNamedSorts() Return list of available named sorts.
FacetSearchConfig	getFacetSearchConfig() Returns the facet search configuration.
java.util.List<java.lang.Exception>	getFailureExceptions() Returns all failure causing exceptions for this FacetSearchContext.
IndexedType	getIndexedType() Returns the indexed type.
IndexedTypeSort	getNamedSort() Return current named sort.
java.util.Collection<CatalogVersionModel>	getParentSessionCatalogVersions() Returns the parent session catalog versions (the catalog versions that are in the session when this context is created).
java.util.Map<java.lang.String,java.lang.String>	getSearchHints() Returns a mutable Map that can be used to store search hints.
SearchQuery	getSearchQuery() Returns the search query.
SearchResult	getSearchResult() Returns the search result.
FacetSearchContext.Status	getStatus() Returns the current status for this FacetSearchContext
void	setNamedSort(IndexedTypeSort namedSort) Sets current named sort IndexedTypeSort.
void	setSearchResult(SearchResult searchResult) Sets the search result.

Method Detail

getFacetSearchConfig

FacetSearchConfig getFacetSearchConfig()

Returns the facet search configuration.

Returns:

the facet search configuration

getIndexedType

IndexedType getIndexedType()

Returns the indexed type.

Returns:

the indexed type

getSearchQuery

SearchQuery getSearchQuery()

Returns the search query.

Returns:

the search query

getSearchResult

SearchResult getSearchResult()

Returns the search result.

Returns:

the search result

setSearchResult

void setSearchResult(SearchResult searchResult)

Sets the search result.

getParentSessionCatalogVersions

java.util.Collection<CatalogVersionModel> getParentSessionCatalogVersions()

Returns the parent session catalog versions (the catalog versions that are in the session when this context is created).

Returns:

the parent session catalog versions

getSearchHints

java.util.Map<java.lang.String,java.lang.String> getSearchHints()

Returns a mutable Map that can be used to store search hints.

Returns:

the map containing the search hints

getStatus

FacetSearchContext.Status getStatus()

Returns the current status for this FacetSearchContext

Returns:

the current status

getFailureExceptions

java.util.List<java.lang.Exception> getFailureExceptions()

Returns all failure causing exceptions for this FacetSearchContext.

getAttributes

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

Returns a Map instance that can be used to store attributes. The attributes are only valid for the duration of the search process.

Returns:

the map containing the attributes

getAvailableNamedSorts

java.util.List<IndexedTypeSort> getAvailableNamedSorts()

Return list of available named sorts.

Returns:

List of IndexedTypeSort

getNamedSort

IndexedTypeSort getNamedSort()

Return current named sort.

Returns:

Current named sort IndexedTypeSort

setNamedSort

void setNamedSort(IndexedTypeSort namedSort)

Sets current named sort IndexedTypeSort.