001/*
002 * (C) Copyright 2010-2013 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Olivier Grisel
018 */
019package org.nuxeo.ecm.platform.suggestbox.service;
020
021import java.util.List;
022
023import org.nuxeo.ecm.platform.suggestbox.service.descriptors.SuggesterDescriptor;
024
025public interface Suggester {
026
027    /**
028     * Compute a list of possible user actions or intents given their input and context.
029     *
030     * @param userInput text typed by the user
031     * @param context user context
032     * @return generated suggestion for the given input and context
033     * @throws SuggestionException if the configuration or context are inconsistent, or a backing service is failing.
034     */
035    List<Suggestion> suggest(String userInput, SuggestionContext context) throws SuggestionException;
036
037    /**
038     * Configure the Suggester instance with the parameters from the XML descriptor.
039     *
040     * @param descriptor XMap descriptor with the aggregate configuration information of the component.
041     */
042    void initWithParameters(SuggesterDescriptor descriptor) throws ComponentInitializationException;
043}