OSDN Git Service

original
[gb-231r1-is01/Gingerbread_2.3.3_r1_IS01.git] / frameworks / base / core / java / android / widget / FilterQueryProvider.java
1 /*
2  * Copyright (C) 2007 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 android.widget;
18
19 import android.database.Cursor;
20
21 /**
22  * This class can be used by external clients of CursorAdapter and
23  * CursorTreeAdapter to define how the content of the adapter should be
24  * filtered.
25  * 
26  * @see #runQuery(CharSequence)
27  */
28 public interface FilterQueryProvider {
29     /**
30      * Runs a query with the specified constraint. This query is requested
31      * by the filter attached to this adapter.
32      *
33      * Contract: when constraint is null or empty, the original results,
34      * prior to any filtering, must be returned.
35      *
36      * @param constraint the constraint with which the query must
37      *        be filtered
38      *
39      * @return a Cursor representing the results of the new query
40      */
41     Cursor runQuery(CharSequence constraint);
42 }