packages/apps/QuickSearchBox/src/com/android/quicksearchbox/CorpusResult.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
  20 /**
  21  * A sequence of suggestions from a single corpus.
  22  */
  23 public interface CorpusResult extends SuggestionCursor {
  24
  25     /**
  26      * Gets the corpus that produced these suggestions.
  27      */
  28     Corpus getCorpus();
  29
  30     /**
  31      * The user query that returned these suggestions.
  32      */
  33     String getUserQuery();
  34
  35     /**
  36      * Gets the latency of the suggestion query that produced this result.
  37      *
  38      * @return The latency in milliseconds.
  39      */
  40     int getLatency();
  41 }