org.nuxeo.ecm.platform.suggestbox.service

Interface SuggestionService

All Known Implementing Classes:

SuggestionServiceImpl

public interface SuggestionService

Pluggable service to generate user action suggestions based on text input and contextual data.

This services aims to build more natural user interfaces for search and navigation by trying to interpret and make explicit possible user intents.

Possible usages of this service:

• make the top right JSF search box more useful with ajax auto-completion that leads to typed suggestions
• custom auto-complete field in layouts
• smart mobile application using a Content Automation operation for suggesting next operations / chains

Since:

5.5

Author:

ogrisel

Method Summary

Methods

Modifier and Type	Method and Description
Object	handleSelection(Suggestion suggestion, SuggestionContext context) Call the Content Automation Operation chain matching the suggestion selected by the user.
List<Suggestion>	suggest(String userInput, SuggestionContext context) Call the suggesters registered for the given suggestion point mentioned in the context and aggregate the results.
List<Suggestion>	suggest(String searchKeywords, SuggestionContext suggestionContext, String suggester) Call a single suggester registered under the provided name.

Method Detail

suggest

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

Call the suggesters registered for the given suggestion point mentioned in the context and aggregate the results.

Parameters:

userInput - text typed by the user

context - user context (with suggestPoint name and more)

Returns:

generated suggestion for the given input and context

Throws:

SuggestionException

suggest

List<Suggestion> suggest(String searchKeywords,
                       SuggestionContext suggestionContext,
                       String suggester)
                         throws SuggestionException

Call a single suggester registered under the provided name.

Parameters:

userInput - text typed by the user

suggestionContext - user context (with suggestPoint name and more)

suggester - the registration name of the suggester to use

Returns:

generated suggestion for the given input and context

Throws:

SuggestionException

handleSelection

Object handleSelection(Suggestion suggestion,
                     SuggestionContext context)
                       throws SuggestionHandlingException

Call the Content Automation Operation chain matching the suggestion selected by the user.

Parameters:

suggestion - the selected suggestion to execute

context - the suggestion context that is also passed to as Content Automation context.

Returns:

the outcome of the selected operation chain. In a JSF / Seam environment, the outcome is passed as a String to the JSF runtime. In a JAX-RS environment the outcome could be passed as a resource path for redirect navigation.

Throws:

SuggestionHandlingException