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

Class TypeAheadResponse

java.lang.Object

com.broadleafcommerce.search.api.domain.typeahead.TypeAheadResponse

public class TypeAheadResponse
extends Object

Constructor Summary

Constructors

Constructor	Description
TypeAheadResponse()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getDebug()	The raw query response for debugging purposes.
LinkedHashSet<SuggestionPhrase>	getKeyWords()	The keywords associated with this response.
Map<String,List<Map<String,Object>>>	getSuggestions()	A map of suggestions, with the key being the name of the origin of the suggestion.
int	hashCode()
void	setDebug(String debug)	The raw query response for debugging purposes.
void	setKeyWords(LinkedHashSet<SuggestionPhrase> keyWords)	The keywords associated with this response.
void	setSuggestions(Map<String,List<Map<String,Object>>> suggestions)	A map of suggestions, with the key being the name of the origin of the suggestion.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TypeAheadResponse

public TypeAheadResponse()

Method Detail

getKeyWords

public LinkedHashSet<SuggestionPhrase> getKeyWords()

The keywords associated with this response. These are the text predictions shown to the user.

Returns:

keywords associated with this response

getSuggestions

public Map<String,List<Map<String,Object>>> getSuggestions()

A map of suggestions, with the key being the name of the origin of the suggestion. For example, it may be manufacturer, name, title, etc.

Returns:

map of suggestions

getDebug

@Nullable
public String getDebug()

The raw query response for debugging purposes.

Returns:

raw query response

setKeyWords

public void setKeyWords(LinkedHashSet<SuggestionPhrase> keyWords)

The keywords associated with this response. These are the text predictions shown to the user.

Parameters:

keyWords - keywords associated with this response

setSuggestions

public void setSuggestions(Map<String,List<Map<String,Object>>> suggestions)

A map of suggestions, with the key being the name of the origin of the suggestion. For example, it may be manufacturer, name, title, etc.

Parameters:

suggestions - map of suggestions

setDebug

public void setDebug(@Nullable
                     String debug)

The raw query response for debugging purposes.

Parameters:

debug - raw query response

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