Home | History | Annotate | Download | only in quicksearchbox
      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 
     17 package com.android.quicksearchbox;
     18 
     19 
     20 /**
     21  * Interface for objects that can produce a SuggestionCursor given a query.
     22  */
     23 public interface SuggestionCursorProvider<C extends SuggestionCursor> {
     24 
     25     /**
     26      * Gets the name of the provider. This is used for logging and
     27      * to execute tasks on the queue for the provider.
     28      */
     29     String getName();
     30 
     31     /**
     32      * Gets suggestions from the provider.
     33      *
     34      * @param query The user query.
     35      * @param queryLimit An advisory maximum number of results that the source should return.
     36      * @param onlyOne Indicates if this provider is the only one being used for the query.
     37      * @return The suggestion results. Must not be {@code null}.
     38      */
     39     C getSuggestions(String query, int queryLimit, boolean onlyOne);
     40 }
     41