Home | History | Annotate | Download | only in quicksearchbox
      1 /*
      2  * Copyright (C) 2010 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 package com.android.quicksearchbox;
     17 
     18 import org.json.JSONException;
     19 
     20 import java.util.Collection;
     21 
     22 /**
     23  * Extra data that can be attached to a suggestion.
     24  */
     25 public interface SuggestionExtras {
     26 
     27     /**
     28      * Return the names of custom columns present in these extras.
     29      */
     30     Collection<String> getExtraColumnNames();
     31 
     32     /**
     33      * @param columnName The column to get a value from.
     34      */
     35     String getExtra(String columnName);
     36 
     37     /**
     38      * Flatten these extras as a JSON object.
     39      */
     40     String toJsonString() throws JSONException;
     41 
     42 }
     43