org.nuxeo.ecm.platform.suggestbox.service.suggesters

Class UserGroupLookupSuggester

java.lang.Object

org.nuxeo.ecm.platform.suggestbox.service.suggesters.UserGroupLookupSuggester

All Implemented Interfaces:

Suggester

public class UserGroupLookupSuggester
extends Object
implements Suggester

Perform a lookup by name query on the UserManager service and suggest to navigate to the top user and / or group profiles matching that query. If searchFields are provided in the parameters, suggestion for searching document with reference to the users are also generated.

Author:

ogrisel

Field Summary

Fields

Modifier and Type	Field and Description
protected SuggesterDescriptor	descriptor
protected String	groupIconURL
protected int	groupSuggestionsLimit
protected List<String>	searchFields
protected String	searchIconURL
protected String	searchLabelPrefix
protected String	suggesterId
protected String	userIconURL
protected int	userSuggestionsLimit

Constructor Summary

Constructors

Constructor and Description
UserGroupLookupSuggester()

Method Summary

Modifier and Type	Method and 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.

Methods inherited from class java.lang.Object

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

Field Detail

userIconURL

protected String userIconURL

groupIconURL

protected String groupIconURL

searchIconURL

protected String searchIconURL

descriptor

protected SuggesterDescriptor descriptor

searchFields

protected List<String> searchFields

searchLabelPrefix

protected final String searchLabelPrefix

See Also:

Constant Field Values

userSuggestionsLimit

protected int userSuggestionsLimit

groupSuggestionsLimit

protected int groupSuggestionsLimit

suggesterId

protected String suggesterId

Constructor Detail

UserGroupLookupSuggester

public UserGroupLookupSuggester()

Method Detail

suggest

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

Description copied from interface: Suggester

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

Specified by:

suggest in interface Suggester

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

public void initWithParameters(SuggesterDescriptor descriptor)

Description copied from interface: Suggester

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

Specified by:

initWithParameters in interface Suggester

Parameters:

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