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 -
Method Summary
Modifier and TypeMethodDescriptionReturns aMapinstance that can be used to store attributes.Return list of available named sorts.Returns the facet search configuration.Returns all failure causing exceptions for thisFacetSearchContext.Returns the indexed type.Return current named sort.Returns the parent session catalog versions (the catalog versions that are in the session when this context is created).Returns a mutableMapthat can be used to store search hints.Returns the search query.Returns the search result.Returns the current status for thisFacetSearchContextvoidsetNamedSort(IndexedTypeSort namedSort) Sets current named sortIndexedTypeSort.voidsetSearchResult(SearchResult searchResult) Sets the search result.
-
Method Details
-
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
Sets the search result. -
getParentSessionCatalogVersions
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
Returns a mutableMapthat can be used to store search hints.- Returns:
- the map containing the search hints
-
getStatus
FacetSearchContext.Status getStatus()Returns the current status for thisFacetSearchContext- Returns:
- the current status
-
getFailureExceptions
Returns all failure causing exceptions for thisFacetSearchContext. -
getAttributes
Returns aMapinstance 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
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
Sets current named sortIndexedTypeSort.
-