Package de.xima.fc.plugin.interfaces.form

Interface IPluginDataSource

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginDataSource
extends IFCPlugin

Interface for a data source plugin. A data source plugin provides an additional source for select items in the formcycle Designer. Each select item consists of a value that is submitted when the form is sent, and a title that is displayed to the user in the select form element.

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

Method Summary

Modifier and Type	Method	Description
IPluginDataSourceRetVal	resolve(IPluginDataSourceParams params)	This is the main method that should return the data this data source plugin provides.

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, getDescription, getDisplayName, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall, validateConfigurationData

Method Details

resolve

IPluginDataSourceRetVal resolve(IPluginDataSourceParams params)
                         throws FCPluginException

This is the main method that should return the data this data source plugin provides.

When any exception other than FCPluginException is thrown, the form is still rendered, but the default select options for the select as set in the formcycle designer are used.

Parameters:

params - The parameters this plugin may make use of. Contains for example the current client and the current form.

Returns:

The list of items that is provided by this data source plugin.

Throws:

FCPluginException - May be thrown when this plugin cannot provide the data. If this exception is thrown, the form is still rendered and the select item will not have any options available.