com.adobe.granite.omnisearch.api.suggestion

Class SuggestionResult

java.lang.Object

com.adobe.granite.omnisearch.api.suggestion.SuggestionResult

@ProviderType
public final class SuggestionResult
extends java.lang.Object

SuggestionResult encapsulate results of suggestion query, spellcheck and predicate suggestion

Constructor Summary

Constructors

Constructor and Description
SuggestionResult(java.util.List<java.lang.String> suggestions, java.util.List<java.lang.String> spellCheckSuggestions, java.util.List<PredicateSuggestion> predicateSuggestions) Creates new SuggestionResult instance

Method Summary

Modifier and Type	Method and Description
java.util.List<PredicateSuggestion>	getPredicateSuggestions() This function returnsList of PredicateSuggestions for the module.
java.util.List<java.lang.String>	getSpellcheckSuggestions() this function returns the spell check suggestions for the search term for the module.
java.util.List<java.lang.String>	getSuggestions() This function returns the list of suggestions for search term for the module.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SuggestionResult

public SuggestionResult(java.util.List<java.lang.String> suggestions,
                        java.util.List<java.lang.String> spellCheckSuggestions,
                        java.util.List<PredicateSuggestion> predicateSuggestions)

Creates new SuggestionResult instance

Parameters:

suggestions - List of suggestions

spellCheckSuggestions - List of spellcheck suggestions

predicateSuggestions - List of PredicateSuggestion

Method Detail

getPredicateSuggestions

public java.util.List<PredicateSuggestion> getPredicateSuggestions()

This function returnsList of PredicateSuggestions for the module.

Returns:

list

getSuggestions

public java.util.List<java.lang.String> getSuggestions()

This function returns the list of suggestions for search term for the module.

Returns:

list

getSpellcheckSuggestions

public java.util.List<java.lang.String> getSpellcheckSuggestions()

this function returns the spell check suggestions for the search term for the module.

Returns:

list