Wiki source code of Generisches Plugin
Hide last authors
author | version | line-number | content |
---|---|---|---|
1.1 | 1 | {{content/}} | |
2 | |||
2.1 | 3 | **[[Download demo project for this plugin type>>url:https://customer.formcycle.eu/index.php/s/TysXcyTvPsyxWh8||rel="noopener noreferrer" target="_blank"]]** | |
1.1 | 4 | ||
5 | == IPluginGeneric == | ||
6 | |||
2.1 | 7 | === Uses === | |
1.1 | 8 | ||
2.1 | 9 | The generic plugin is not included in any process chain of {{formcycle case="dat"/}}. | |
10 | The //execute// method provided by the plugin must therefore be addressed by its own logic. | ||
11 | Plugins of this type are instantiated during the registration process and removed from the running system during the de-registration process. | ||
1.1 | 12 | ||
13 | |||
2.1 | 14 | This plugin type is therefore suitable for making file resources from the plugin bundle available in the {{formcycle/}} system, for example. | |
15 | Furthermore, resources that are no longer required can be removed from the system when the plug-in bundle is uninstalled. | ||
16 | All necessary interfaces are provided by the [[Base interface IFCPlugin>>doc:IFCPlugin]]. | ||
1.1 | 17 | ||
2.1 | 18 | === Method signatures === | |
1.1 | 19 | ||
20 | {{panel title="{{code language='java'~}~}IPluginGenericRetVal execute(IPluginGenericParams params) throws FCPluginException{{/code~}~}" triggerable="true" fullwidth="true"}} | ||
21 | ((( | ||
2.1 | 22 | **Transfer values:** | |
1.1 | 23 | ||
2.1 | 24 | * The //IPluginGenericParams// type provides the following properties: | |
25 | ** **getParameterMap():** a map with parameters in serialised form. | ||
1.1 | 26 | ))) | |
2.1 | 27 | **Return values:** | |
1.1 | 28 | ((( | |
2.1 | 29 | 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. | |
1.1 | 30 | ))) | |
31 | {{/panel}} |