Package com.broadleafcommerce.search.provider.solr.response

Interface SolrResponseDecorator

All Known Implementing Classes:
SolrResponseDebugDecorator, SolrResponseFacetDecorator, SolrResponseRangedFacetDecorator, SolrResponseSortDecorator, SolrResponseSpellCheckDecorator, SolrResponseStandardFacetDecorator
public interface SolrResponseDecorator
Implementations of this interface will populate some extra information on the SearchResponse.

  • Method Summary

    Modifier and Type
    Method
    Description
    <T extends com.broadleafcommerce.search.api.domain.SearchResponse>
    void
    decorate(T searchResponse, com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, org.apache.solr.client.solrj.response.QueryResponse queryResponse, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, org.springframework.data.domain.Pageable page, com.broadleafcommerce.search.core.service.SearchRequestProperties properties, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Add some extra information to the SearchResponse.

  • Method Details

    • decorate

      <T extends com.broadleafcommerce.search.api.domain.SearchResponse> void decorate(T searchResponse, com.broadleafcommerce.search.api.domain.SearchRequest searchRequest, org.apache.solr.client.solrj.response.QueryResponse queryResponse, List<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitions, org.springframework.data.domain.Pageable page, com.broadleafcommerce.search.core.service.SearchRequestProperties properties, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Add some extra information to the SearchResponse.
      Parameters:
      searchResponse - Search response to be updated
      searchRequest - Original search request
      queryResponse - Response from Solr for search
      fieldDefinitions - An unmodifiable list of field definitions used on the original search
      page - The requested page for the search
      properties - Additional properties for this search
      context - (optional) The context information surrounding sandboxing/multitenant state