SuggestionsProvider.java revision 3e44ff1f2a204db3f479698cf0b3eab3d451dec2 
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 * Provides a set of suggestion results for a query..
21 *
22 */
23public interface SuggestionsProvider {
24    /**
25     * Gets suggestions for a query. This method will be called on a background thread.
26     *
27     * @return A {@link Suggestions} object. Implementations are allowed to call
28     *         {@link Suggestions#addSourceResult(SuggestionCursor)} after returning,
29     *         but must do so on the UI thread.
30     */
31    Suggestions getSuggestions(String query);
32
33    void close();
34}
35