Package de.xima.fc.plugin.models.retval.form

Class PluginDataSourceRetVal

java.lang.Object

de.xima.fc.plugin.models.retval.form.PluginDataSourceRetVal

All Implemented Interfaces:

IPluginReturnValue, IPluginDataSourceRetVal, Serializable

public class PluginDataSourceRetVal
extends Object
implements IPluginDataSourceRetVal

See Also:

• Serialized Form

Field Summary

Fields inherited from interface de.xima.fc.interfaces.plugin.retval.form.IPluginDataSourceRetVal

TEXT, VALUE

Constructor Summary

Constructors

Constructor	Description
PluginDataSourceRetVal(SerializableJSONArray jsonArray)

Method Summary

Modifier and Type	Method	Description
SerializableJSONArray	getJSONArray()	Each data source consists of a list of items.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PluginDataSourceRetVal

public PluginDataSourceRetVal(SerializableJSONArray jsonArray)

Method Details

getJSONArray

public SerializableJSONArray getJSONArray()

Description copied from interface: IPluginDataSourceRetVal

Each data source consists of a list of items. This is the getter for the list of items provided by the corresponding data source plugin. Each item must be a JSONObject with the following key-value pairs (both strings):

• IPluginDataSourceRetVal.TEXT The text that is shown to the user.
• IPluginDataSourceRetVal.VALUE The text that is sent when the form is submitted.
• title (optional) The text that is used as the HTML title attribute.

Specified by:

getJSONArray in interface IPluginDataSourceRetVal

Returns:

A SerializableJSONArray with the items provided by the data source plugin.