Package org.nuxeo.ecm.platform.suggestbox.service

Interface Suggester

All Known Implementing Classes:

DocumentLookupSuggester, DocumentSearchByDateSuggester, DocumentSearchByPropertySuggester, UserGroupLookupSuggester

public interface Suggester

Method Summary

Modifier and Type	Method	Description
void	initWithParameters(SuggesterDescriptor descriptor)	Configure the Suggester instance with the parameters from the XML descriptor.
List<Suggestion>	suggest(String userInput, SuggestionContext context)	Compute a list of possible user actions or intents given their input and context.

Method Detail

suggest

List<Suggestion> suggest(String userInput,
                         SuggestionContext context)
                  throws SuggestionException

Compute a list of possible user actions or intents given their input and context.

Parameters:

userInput - text typed by the user

context - user context

Returns:

generated suggestion for the given input and context

Throws:

SuggestionException - if the configuration or context are inconsistent, or a backing service is failing.

initWithParameters

void initWithParameters(SuggesterDescriptor descriptor)
                 throws ComponentInitializationException

Configure the Suggester instance with the parameters from the XML descriptor.

Parameters:

descriptor - XMap descriptor with the aggregate configuration information of the component.

Throws:

ComponentInitializationException