org.nuxeo.ecm.platform.suggestbox.jsf

Class SuggestboxActions

java.lang.Object

org.nuxeo.ecm.platform.ui.web.invalidations.DocumentContextBoundActionBean

org.nuxeo.ecm.platform.suggestbox.jsf.SuggestboxActions

All Implemented Interfaces:

Serializable

@Name(value="suggestboxActions")
@Scope(value=CONVERSATION)
public class SuggestboxActions
extends DocumentContextBoundActionBean
implements Serializable

Back seam component for the top right search box using the suggestion service to help decode the user intent and minimize the number of clicks to find the relevant information.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SuggestboxActions()

Method Summary

Methods

Modifier and Type	Method and Description
String	getSearchKeywords()
String	getSuggesterGroup()
List<Suggestion>	getSuggestions(Object input) Callback for the ajax keypress event that triggers the generation of context sensitive action suggestions.
Object	handleSelection(Suggestion selectedSuggestion) Callback for the ajax selection of an item in the rich:suggestionbox list.
Object	performKeywordsSearch(String suggesterName, String suggesterGroup) Action listener for the old-style search button.
void	setSearchKeywords(String searchKeywords)
void	setSuggesterGroup(String suggesterGroup)

Methods inherited from class org.nuxeo.ecm.platform.ui.web.invalidations.DocumentContextBoundActionBean

onContextChange

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestboxActions

public SuggestboxActions()

Method Detail

getSearchKeywords

public String getSearchKeywords()

setSearchKeywords

public void setSearchKeywords(String searchKeywords)

getSuggesterGroup

public String getSuggesterGroup()

setSuggesterGroup

@RequestParameter
public void setSuggesterGroup(String suggesterGroup)

getSuggestions

public List<Suggestion> getSuggestions(Object input)

Callback for the ajax keypress event that triggers the generation of context sensitive action suggestions. The most specific actions (e.g. direct navigation to a document with matching titles) should be suggested in the first position and more generic (traditional free-text search for documents) last.

handleSelection

public Object handleSelection(Suggestion selectedSuggestion)
                       throws SuggestionHandlingException

Callback for the ajax selection of an item in the rich:suggestionbox list.

Throws:

SuggestionHandlingException

performKeywordsSearch

public Object performKeywordsSearch(String suggesterName,
                           String suggesterGroup)
                             throws SuggestionException,
                                    SuggestionHandlingException

Action listener for the old-style search button.

Throws:

SuggestionException

SuggestionHandlingException