1 /*
2  * Copyright (C) 2019 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.settingslib.search;
18 
19 import android.content.Context;
20 import android.provider.SearchIndexableResource;
21 
22 import java.util.List;
23 
24 /**
25  * Interface for classes whose instances can provide data for indexing.
26  *
27  * See {@link android.provider.SearchIndexableResource} and {@link SearchIndexableRaw}.
28  */
29 public interface Indexable {
30 
31     /**
32      * Interface for classes whose instances can provide data for indexing.
33      */
34     interface SearchIndexProvider {
35         /**
36          * Return a list of references for indexing.
37          *
38          * See {@link android.provider.SearchIndexableResource}
39          *
40          * @param context the context.
41          * @param enabled hint telling if the data needs to be considered into the search results
42          *                or not.
43          * @return a list of {@link android.provider.SearchIndexableResource} references.
44          * Can be null.
45          */
getXmlResourcesToIndex(Context context, boolean enabled)46         List<SearchIndexableResource> getXmlResourcesToIndex(Context context, boolean enabled);
47 
48         /**
49          * Return a list of raw data for indexing. See {@link SearchIndexableRaw}
50          *
51          * @param context the context.
52          * @param enabled hint telling if the data needs to be considered into the search results
53          *                or not.
54          * @return a list of {@link SearchIndexableRaw} references. Can be null.
55          */
getRawDataToIndex(Context context, boolean enabled)56         List<SearchIndexableRaw> getRawDataToIndex(Context context, boolean enabled);
57 
58         /**
59          * Return a list of dynamic raw data for indexing. See {@link SearchIndexableRaw}
60          *
61          * @param context the context.
62          * @param enabled hint telling if the data needs to be considered into the search results
63          *                or not.
64          * @return a list of {@link SearchIndexableRaw} references. Can be null.
65          */
getDynamicRawDataToIndex(Context context, boolean enabled)66         List<SearchIndexableRaw> getDynamicRawDataToIndex(Context context, boolean enabled);
67 
68         /**
69          * Return a list of data keys that cannot be indexed. See {@link SearchIndexableRaw}
70          *
71          * @param context the context.
72          * @return a list of {@link SearchIndexableRaw} references. Can be null.
73          */
getNonIndexableKeys(Context context)74         List<String> getNonIndexableKeys(Context context);
75     }
76 }
77