Generic plugin

Modified on Mon, 17 Jul, 2023 at 8:58 AM

Download demo project for this plugin type

IPluginGeneric

Uses

The generic plugin is not included in any process chain of FORMCYCLE.
The execute method provided by the plugin must therefore be addressed by its own logic.
Plugins of this type are instantiated during the registration process and removed from the running system during the de-registration process.

This plugin type is therefore suitable for making file resources from the plugin bundle available in the FORMCYCLE system, for example. Furthermore, resources that are no longer required can be removed from the system when the plug-in bundle is uninstalled. All necessary interfaces are provided by the Base interface IFCPlugin.

Method signatures

IPluginGenericRetVal execute(IPluginGenericParams params) throws FCPluginException

Transfer values:

The IPluginGenericParamstype provides the following properties:
- getParameterMap(): a map with parameters in serialised form.

Return values:

Return values must be of type IPluginGenericRetVal, a reference implementation is provided by the PluginGenericRetVal class. A map with serialisable content can be passed to this object in the constructor.