Mark Rogers f9dee792a5 Merged HEAD-BUG-FIX (5.0/Cloud) to HEAD (5.0/Cloud)
84919: Merged PLATFORM1 (5.0/Cloud) to HEAD-BUG-FIX (5.0/Cloud)
      83447: ACE-2612: Initial implementation of the Suggester service to support the auto-suggest web script.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@85237 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2014-09-20 09:09:54 +00:00

47 lines
1.5 KiB
Java

/*
* Copyright (C) 2005-2014 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.service.cmr.search;
/**
* A service that returns term suggestions
*
* @author Jamal Kaabi-Mofrad
* @since 5.0
*/
public interface SuggesterService
{
/**
* Whether the Suggester is enabled (refer to 'solr.suggester.enabled' repository property) or not
*
* @return true if the Suggester is enabled, false otherwise
*/
public boolean isEnabled();
/**
* Get suggestions for the specified term
*
* @param term the term to use for the search
* @param limit the number of suggestions for Solr to return
* @return term suggestions result. Never <i>null</i>
*/
public SuggesterResult getSuggestions(String term, int limit);
}