SuggestionsProvider.java revision 81a0897ff9685f3313c58294bf7973700c468b2b
1/* 2 * Copyright (C) 2009 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package com.android.quicksearchbox; 18 19 20/** 21 * Provides a set of suggestion results for a query.. 22 * 23 */ 24public interface SuggestionsProvider { 25 /** 26 * Gets suggestions for a query. 27 * 28 * @param query The query. 29 * @param singleCorpus The corpora to query, {@code null} for all enabled corpora. 30 * @param maxSuggestions The maximum number of suggestions to return. 31 */ 32 Suggestions getSuggestions(String query, Corpus singleCorpus, int maxSuggestions); 33 34 void close(); 35} 36