Package com.broadleafcommerce.search.api.domain

Class SearchResponse

java.lang.Object
com.broadleafcommerce.search.api.domain.PagedModel<Object>
com.broadleafcommerce.search.api.domain.SearchResponse
public class SearchResponse extends PagedModel<Object>
Represents the results from a search.

  • Constructor Details

    • SearchResponse

      public SearchResponse(List<Object> content, org.springframework.data.domain.Pageable pageable, long total)

  • Method Details

    • getFacets

      public List<FacetResponse> getFacets()
      The facets returned in the search result.
      Returns:
      facets returned in the search result

    • getSorts

      public List<SortResponse> getSorts()
      The sort options returned in the search result.
      Returns:
      sort options returned in the search result

    • getRedirect

      public SearchRedirectResponse getRedirect()
      A redirect generated based on the original request query.

      If present, the rest of the response will be empty.

      Returns:
      redirect to perform in place of search results

    • isCorrectedQuery

      public boolean isCorrectedQuery()
      If no results were found and a different query was executed than the original, this is set to true.
      Returns:
      whether this response is for a different corrected query

    • getSpellCheckResult

      public SpellCheckResult getSpellCheckResult()
      Set if spellcheck returned any results. Contains the original query and any potential suggestions.
      Returns:
      spell check results and suggestions

    • setFacets

      public void setFacets(List<FacetResponse> facets)
      The facets returned in the search result.
      Parameters:
      facets - facets returned in the search result

    • setSorts

      public void setSorts(List<SortResponse> sorts)
      The sort options returned in the search result.
      Parameters:
      sorts - sort options returned in the search result

    • setRedirect

      public void setRedirect(SearchRedirectResponse redirect)
      A redirect generated based on the original request query.

      If present, the rest of the response will be empty.

      Parameters:
      redirect - redirect to perform in place of search results

    • setCorrectedQuery

      public void setCorrectedQuery(boolean correctedQuery)
      If no results were found and a different query was executed than the original, this is set to true.
      Parameters:
      correctedQuery - whether this response is for a different corrected query

    • setSpellCheckResult

      public void setSpellCheckResult(SpellCheckResult spellCheckResult)
      Set if spellcheck returned any results. Contains the original query and any potential suggestions.
      Parameters:
      spellCheckResult - spell check results and suggestions

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class PagedModel<Object>

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class PagedModel<Object>