de.xima.fc.plugin.config

Interface IPluginConfigParamList

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginConfigParamList
extends IFCPlugin

Interface for workflow action plugins (IPluginProcessing). By implementing this interface, you can prefill the list of available parameters shown on the configuration page of the workflow action.

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.entities.interfaces.INameProviding

ATTR_NAME, COL_NAME

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

ATTR_DISPLAY_NAME

Method Summary

Modifier and Type	Method and Description
Map<String,IPluginConfigParam>	getConfigParameter() This method should return a map of parameters required by the workflow action plugin.

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

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

Method Detail

getConfigParameter

Map<String,IPluginConfigParam> getConfigParameter()

This method should return a map of parameters required by the workflow action plugin. The key is the name of the parameter, the value must be an instance of IPluginConfigParam with some details about the parameters, such as its default value and whether it is required.

Returns:

A map between the key of the property and the meta data of that property.