001/*
002 * (C) Copyright 2010-2013 Nuxeo SA (http://nuxeo.com/) and contributors.
003 *
004 * All rights reserved. This program and the accompanying materials
005 * are made available under the terms of the GNU Lesser General Public License
006 * (LGPL) version 2.1 which accompanies this distribution, and is available at
007 * http://www.gnu.org/licenses/lgpl.html
008 *
009 * This library is distributed in the hope that it will be useful,
010 * but WITHOUT ANY WARRANTY; without even the implied warranty of
011 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
012 * Lesser General Public License for more details.
013 *
014 * Contributors:
015 *     Olivier Grisel
016 */
017package org.nuxeo.ecm.platform.suggestbox.service;
018
019import java.util.List;
020
021import org.nuxeo.ecm.platform.suggestbox.service.descriptors.SuggesterDescriptor;
022
023public interface Suggester {
024
025    /**
026     * Compute a list of possible user actions or intents given their input and context.
027     *
028     * @param userInput text typed by the user
029     * @param context user context
030     * @return generated suggestion for the given input and context
031     * @throws SuggestionException if the configuration or context are inconsistent, or a backing service is failing.
032     */
033    List<Suggestion> suggest(String userInput, SuggestionContext context) throws SuggestionException;
034
035    /**
036     * Configure the Suggester instance with the parameters from the XML descriptor.
037     *
038     * @param descriptor XMap descriptor with the aggregate configuration information of the component.
039     */
040    void initWithParameters(SuggesterDescriptor descriptor) throws ComponentInitializationException;
041}