packages/apps/QuickSearchBox/src/com/android/quicksearchbox/Promoter.java

   1 /*
   2  * Copyright (C) 2009 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.quicksearchbox;
  18
  19 import java.util.ArrayList;
  20
  21 /**
  22  * Promoters choose which suggestions to promote from all the available suggestions.
  23  *
  24  */
  25 public interface Promoter {
  26
  27     /**
  28      * Gets the promoted suggestions.
  29      *
  30      * @param shortcuts The shortcuts for the query.
  31      * @param suggestions The suggestions from each source.
  32      * @param maxPromoted The maximum number of suggestions to promote.
  33      * @param promoted List to add the promoted suggestions to.
  34      */
  35     void pickPromoted(SuggestionCursor shortcuts,
  36             ArrayList<CorpusResult> suggestions, int maxPromoted,
  37             ListSuggestionCursor promoted);
  38
  39 }