Interface IPluginGeneric

  • All Superinterfaces:
    IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

    public interface IPluginGeneric
    extends IFCPlugin
    Interface for a generic plugin. A generic plugin is never executed by the formcycle system itself and needs to be called manually. The available parameters and the return value are a generic map. When you call this plugin manually, you need to make sure you provide the correct parameters.

    This currently exists mainly for compatibility reasons and should not be used in favor of more specific plugins.

    Author:
    XIMA MEDIA GmbH
    • Method Detail

      • execute

        IPluginGenericRetVal execute​(IPluginGenericParams params)
                              throws FCPluginException
        This is the main method that performs the plugin logic.
        Parameters:
        params - The parameters this plugin may make use of. The parameters consist of a generic map with data as given by the caller.
        Returns:
        The data this generic plugin wants to return to the caller.
        Throws:
        FCPluginException - May be thrown when this plugin cannot perform its task.