org.alfresco.service.cmr.search

Interface SuggesterService

All Known Implementing Classes:

DummySuggesterServiceImpl, SolrSuggesterServiceImpl

public interface SuggesterService

A service that returns term suggestions

Since:

5.0

Author:

Jamal Kaabi-Mofrad

Method Summary

Modifier and Type	Method and Description
SuggesterResult	getSuggestions(SuggesterParameters suggesterParameters) Get suggestions for the specified term SuggesterParameters.term
boolean	isEnabled() Whether the Suggester is enabled (refer to 'solr.suggester.enabled' repository property) or not

Method Detail

isEnabled

boolean isEnabled()

Whether the Suggester is enabled (refer to 'solr.suggester.enabled' repository property) or not

Returns:

true if the Suggester is enabled, false otherwise

getSuggestions

SuggesterResult getSuggestions(SuggesterParameters suggesterParameters)

Get suggestions for the specified term SuggesterParameters.term

Parameters:

suggesterParameters - the parameters to use

Returns:

term suggestions result. Never null