Interface FacetSearchContext

All Known Implementing Classes:
DefaultFacetSearchContext

public interface FacetSearchContext
This interface represents a context valid for the duration of a search.
  • 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

      void setSearchResult(SearchResult searchResult)
      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

      Map<String,String> getSearchHints()
      Returns a mutable Map that can be used to store search hints.
      Returns:
      the map containing the search hints
    • 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
    • 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

      void setNamedSort(IndexedTypeSort namedSort)
      Sets current named sort IndexedTypeSort.