Home | History | Annotate | Download | only in search
      1 /*
      2  * Copyright (C) 2015 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.tv.search;
     18 
     19 import com.android.tv.search.LocalSearchProvider.SearchResult;
     20 
     21 import java.util.List;
     22 
     23 /**
     24  * Interface for channel and program search.
     25  */
     26 public interface SearchInterface {
     27     int ACTION_TYPE_START = 1;
     28     int ACTION_TYPE_AMBIGUOUS = 1;
     29     int ACTION_TYPE_SWITCH_CHANNEL = 2;
     30     int ACTION_TYPE_SWITCH_INPUT = 3;
     31     int ACTION_TYPE_END = 3;
     32 
     33     /**
     34      * Search channels, inputs, or programs.
     35      * This assumes that parental control settings will not be change while searching.
     36      *
     37      * @param action One of {@link #ACTION_TYPE_SWITCH_CHANNEL}, {@link #ACTION_TYPE_SWITCH_INPUT},
     38      *               or {@link #ACTION_TYPE_AMBIGUOUS},
     39      */
     40     List<SearchResult> search(String query, int limit, int action);
     41 }
     42