SuggestionExtras.java

/*
 * Copyright (C) 2010 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.android.quicksearchbox;

import org.json.JSONException;

import java.util.Collection;

/**
 * Extra data that can be attached to a suggestion.
 */
public interface SuggestionExtras {

    /**
     * Return the names of custom columns present in these extras.
     */
    Collection<String> getExtraColumnNames();

    /**
     * @param columnName The column to get a value from.
     */
    String getExtra(String columnName);

    /**
     * Flatten these extras as a JSON object.
     */
    String toJsonString() throws JSONException;

}