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
Map<String,Object>	getAttributes() Returns a Map instance that can be used to store attributes.
FacetSearchConfig	getFacetSearchConfig() Returns the facet search configuration.
List<Exception>	getFailureExceptions() Returns all failure causing exceptions for this FacetSearchContext.
IndexedType	getIndexedType() Returns the indexed type.
Map<String,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	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.

getSearchHints

Map<String,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

List<Exception> getFailureExceptions()

Returns all failure causing exceptions for this FacetSearchContext.

getAttributes

Map<String,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