Class UserGroupLookupSuggester
java.lang.Object
org.nuxeo.ecm.platform.suggestbox.service.suggesters.UserGroupLookupSuggester
- All Implemented Interfaces:
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
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
initWithParameters
(SuggesterDescriptor descriptor) Configure the Suggester instance with the parameters from the XML descriptor.suggest
(String userInput, SuggestionContext context) Compute a list of possible user actions or intents given their input and context.
-
Field Details
-
userIconURL
-
groupIconURL
-
searchIconURL
-
descriptor
-
searchFields
-
searchLabelPrefix
- See Also:
-
userSuggestionsLimit
protected int userSuggestionsLimit -
groupSuggestionsLimit
protected int groupSuggestionsLimit -
suggesterId
-
-
Constructor Details
-
UserGroupLookupSuggester
public UserGroupLookupSuggester()
-
-
Method Details
-
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 interfaceSuggester
- Parameters:
userInput
- text typed by the usercontext
- 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
Description copied from interface:Suggester
Configure the Suggester instance with the parameters from the XML descriptor.- Specified by:
initWithParameters
in interfaceSuggester
- Parameters:
descriptor
- XMap descriptor with the aggregate configuration information of the component.
-