org.nuxeo.ecm.platform.suggestbox.service

Class SuggestionServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.platform.suggestbox.service.SuggestionServiceImpl

All Implemented Interfaces:

SuggestionService, Adaptable, Component, Extensible, TimestampedService

public class SuggestionServiceImpl
extends DefaultComponent
implements SuggestionService

The Class SuggestionServiceImpl.

Constructor Summary

Constructors

Constructor and Description
SuggestionServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(ComponentContext context) Activates the component.
SuggesterGroupRegistry	getSuggesterGroups() Gets the suggester groups registry.
SuggestionHandlerRegistry	getSuggestionHandlers() Gets the suggestion handlers registry.
Object	handleSelection(Suggestion suggestion, SuggestionContext suggestionContext) Call the Content Automation Operation chain matching the suggestion selected by the user.
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
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 input, SuggestionContext context, String suggesterName) Call a single suggester registered under the provided name.
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, unregisterExtension

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestionServiceImpl

public SuggestionServiceImpl()

Method Detail

suggest

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

Description copied from interface: SuggestionService

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

Specified by:

suggest in interface SuggestionService

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

public List<Suggestion> suggest(String input,
                       SuggestionContext context,
                       String suggesterName)
                         throws SuggestionException

Description copied from interface: SuggestionService

Call a single suggester registered under the provided name.

Specified by:

suggest in interface SuggestionService

context - user context (with suggestPoint name and more)

suggesterName - the registration name of the suggester to use

Returns:

generated suggestion for the given input and context

Throws:

SuggestionException

handleSelection

public Object handleSelection(Suggestion suggestion,
                     SuggestionContext suggestionContext)
                       throws SuggestionHandlingException

Description copied from interface: SuggestionService

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

Specified by:

handleSelection in interface SuggestionService

Parameters:

suggestion - the selected suggestion to execute

suggestionContext - 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

activate

public void activate(ComponentContext context)
              throws Exception

Description copied from interface: Component

Activates the component.

This method is called by the runtime when a component is activated.

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Parameters:

context - the runtime context

Throws:

Exception - if an error occurs during activation

registerContribution

public void registerContribution(Object contribution,
                        String extensionPoint,
                        ComponentInstance contributor)
                          throws Exception

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

unregisterContribution

public void unregisterContribution(Object contribution,
                          String extensionPoint,
                          ComponentInstance contributor)
                            throws Exception

Overrides:

unregisterContribution in class DefaultComponent

Throws:

Exception

getSuggesterGroups

public SuggesterGroupRegistry getSuggesterGroups()

Gets the suggester groups registry. Only for test purpose.

Returns:

the suggester groups

getSuggestionHandlers

public SuggestionHandlerRegistry getSuggestionHandlers()

Gets the suggestion handlers registry. Only for test purpose.

Returns:

the suggestion handlers