001/**
002 *
003 * Copyright (c) 2014, the Railo Company Ltd. All rights reserved.
004 *
005 * This library is free software; you can redistribute it and/or
006 * modify it under the terms of the GNU Lesser General Public
007 * License as published by the Free Software Foundation; either 
008 * version 2.1 of the License, or (at your option) any later version.
009 * 
010 * This library is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013 * Lesser General Public License for more details.
014 * 
015 * You should have received a copy of the GNU Lesser General Public 
016 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
017 * 
018 **/
019package lucee.runtime.search;
020
021import java.util.Map;
022
023public interface SearchData  {
024
025        public Map getSuggestion();
026        
027        public int getSuggestionMax();
028        
029        public void setSuggestionQuery(String suggestionQuery);
030        
031        public String getSuggestionQuery();
032        
033        /**
034         * increments the searched records
035         * @param count records searched
036         * @return all records searched
037         */
038        public int addRecordsSearched(int count);
039
040        /**
041         * return the records searched
042         */
043        public int getRecordsSearched();
044}