io.elastic.api.SelectModelProvider Maven / Gradle / Ivy
package io.elastic.api;
import javax.json.JsonObject;
/**
* Interface to be implemented by components which want to provide select model.
*/
public interface SelectModelProvider {
/**
* Allows a component to dynamically populate select boxes.
* The given configuration object contains authentication data
* that might be required if the values are retrieved from the desired service.
* The method must return a simple JSON object in which the keys are mapped
* to human readable labels, as shown in the following example.
*
*
*
* {
* "de" : "Germany"
* "us" : "United States"
* }
*
*
*
* @param configuration Config data needed to execute the method
* @return the select model for a particular select box
*/
JsonObject getSelectModel(JsonObject configuration);
}