com.adobe.granite.omnisearch.api.suggestion.SuggestionResult Maven / Gradle / Ivy
/*************************************************************************
*
* ADOBE CONFIDENTIAL
* __________________
*
* Copyright 2015 Adobe Systems Incorporated
* All Rights Reserved.
*
* NOTICE: All information contained herein is, and remains
* the property of Adobe Systems Incorporated and its suppliers,
* if any. The intellectual and technical concepts contained
* herein are proprietary to Adobe Systems Incorporated and its
* suppliers and are protected by trade secret or copyright law.
* Dissemination of this information or reproduction of this material
* is strictly forbidden unless prior written permission is obtained
* from Adobe Systems Incorporated.
**************************************************************************/
package com.adobe.granite.omnisearch.api.suggestion;
import org.osgi.annotation.versioning.ProviderType;
import java.util.List;
/**
* SuggestionResult encapsulate results of suggestion query, spellcheck and predicate suggestion
*/
@ProviderType
public final class SuggestionResult {
private List predicateSuggestions;
private List suggestions;
private List spellCheckSuggestions;
/**
* Creates new SuggestionResult instance
* @param suggestions List of suggestions
* @param spellCheckSuggestions List of spellcheck suggestions
* @param predicateSuggestions List of PredicateSuggestion
*/
public SuggestionResult(List suggestions, List spellCheckSuggestions, List predicateSuggestions) {
this.predicateSuggestions = predicateSuggestions;
this.suggestions = suggestions;
this.spellCheckSuggestions = spellCheckSuggestions;
}
/**
* This function returnsList of PredicateSuggestions
* for the module.
* @return list
*/
public List getPredicateSuggestions() {
return predicateSuggestions;
}
/**
* This function returns the list of suggestions for search term
* for the module.
* @return list
*/
public List getSuggestions() {
return suggestions;
}
/**
* this function returns the spell check suggestions for the search term
* for the module.
*
* @return list
*/
public List getSpellcheckSuggestions() {
return spellCheckSuggestions;
}
}