001    /**
002     * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.search.suggest;
016    
017    import com.liferay.portal.kernel.messaging.proxy.MessagingProxy;
018    import com.liferay.portal.kernel.messaging.proxy.ProxyMode;
019    import com.liferay.portal.kernel.search.SearchContext;
020    import com.liferay.portal.kernel.search.SearchException;
021    
022    import java.util.List;
023    import java.util.Map;
024    
025    /**
026     * @author Michael C. Han
027     */
028    @MessagingProxy(mode = ProxyMode.SYNC)
029    public interface QuerySuggester {
030    
031            public String spellCheckKeywords(SearchContext searchContext)
032                    throws SearchException;
033    
034            public Map<String, List<String>> spellCheckKeywords(
035                            SearchContext searchContext, int max)
036                    throws SearchException;
037    
038            public SuggesterResults suggest(
039                            SearchContext searchContext, Suggester suggester)
040                    throws SearchException;
041    
042            public String[] suggestKeywordQueries(SearchContext searchContext, int max)
043                    throws SearchException;
044    
045    }