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