1 /*
2  * Copyright (C) 2017 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.launcher3.search;
17 
18 import java.util.ArrayList;
19 
20 /**
21  * An interface for receiving search results.
22  *
23  * @param <T> Search Result type
24  */
25 public interface SearchCallback<T> {
26 
27     // Search Result Codes
28     int UNKNOWN = 0;
29     int INTERMEDIATE = 1;
30     int FINAL = 2;
31 
32     /**
33      * Called when the search from primary source is complete.
34      *
35      * @param items list of search results
36      */
onSearchResult(String query, ArrayList<T> items)37     void onSearchResult(String query, ArrayList<T> items);
38 
39     /**
40      * Called when the search from primary source is complete.
41      *
42      * @param items            list of search results
43      * @param searchResultCode indicates if the result is final or intermediate for a given query
44      *                         since we can get search results from multiple sources.
45      */
onSearchResult(String query, ArrayList<T> items, int searchResultCode)46     default void onSearchResult(String query, ArrayList<T> items, int searchResultCode) {
47         onSearchResult(query, items);
48     }
49 
50     /**
51      * Called when the search results should be cleared.
52      */
clearSearchResult()53     void clearSearchResult();
54 }
55 
56