1 /*
2  * Copyright (C) 2022 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 package com.android.quicksearchbox
17 
18 /** Interface for objects that can produce a SuggestionCursor given a query. */
19 interface SuggestionCursorProvider<C : SuggestionCursor?> {
20   /**
21    * Gets the name of the provider. This is used for logging and to execute tasks on the queue for
22    * the provider.
23    */
24   val name: String?
25 
26   /**
27    * Gets suggestions from the provider.
28    *
29    * @param query The user query.
30    * @param queryLimit An advisory maximum number of results that the source should return.
31    * @return The suggestion results. Must not be `null`.
32    */
getSuggestionsnull33   fun getSuggestions(query: String?, queryLimit: Int): C?
34 }
35