Package com.broadleafcommerce.search.api.domain.typeahead

Class TypeAheadRequest

java.lang.Object
com.broadleafcommerce.search.api.domain.typeahead.TypeAheadRequest
public class TypeAheadRequest extends Object
Represents the request data for a type-ahead request. Type ahead is used to provide search suggestions including terms, products, categories, and such.

  • Constructor Details

    • TypeAheadRequest

      public TypeAheadRequest()

  • Method Details

    • getQuery

      public String getQuery()
      The TypeAhead query.
      Returns:
      TypeAhead query

    • getConfig

      public String getConfig()
      The configuration to use on this TypeAhead query.
      Returns:
      configuration to use on this TypeAhead query

    • getFilters

      public List<Filter> getFilters()
      The list of filters to apply to this query.
      Returns:
      The list of filters to apply to this query

    • getRuleFilters

      public RuleFilter getRuleFilters()
      Additional rule-based RSQL filters to apply to this query.
      Returns:
      RSQL filters to apply to this query

    • isDebug

      public boolean isDebug()
      If set to true, a string containing debug information about the query results will be returned.
      Returns:
      whether debug information should be returned

    • setQuery

      public void setQuery(String query)
      The TypeAhead query.
      Parameters:
      query - TypeAhead query

    • setConfig

      public void setConfig(String config)
      The configuration to use on this TypeAhead query.
      Parameters:
      config - configuration to use on this TypeAhead query

    • setFilters

      public void setFilters(List<Filter> filters)
      The list of filters to apply to this query.
      Parameters:
      filters - The list of filters to apply to this query

    • setRuleFilters

      public void setRuleFilters(RuleFilter ruleFilters)
      Additional rule-based RSQL filters to apply to this query.
      Parameters:
      ruleFilters - RSQL filters to apply to this query

    • setDebug

      public void setDebug(boolean debug)
      If set to true, a string containing debug information about the query results will be returned.
      Parameters:
      debug - whether debug information should be returned

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object