Package de.xima.fc.plugin.interfaces

Interface IFCPlugin

All Superinterfaces:
INamedUiElement, INameProviding, ITransferable, Serializable
All Known Subinterfaces:
IDescriptionProvidingPlugin, IFCRemoteSyncPlugin, IFormLifecyclePlugin, IPluginAccessProperties, IPluginActionNodeHandler<TData>, IPluginAuthenticationLogic, IPluginAuthenticatorType, IPluginBackendTheme, IPluginClientDashboard, IPluginConditionNodeHandler<TData>, IPluginConfigParamList, IPluginCustomGUI, IPluginDataSource, IPluginEntities, IPluginFormDesignerResource, IPluginFormElementCatalogue, IPluginFormElementPropertiesExtension, IPluginFormElementTemplate, IPluginFormElementTemplateStatic, IPluginFormElementWidget, IPluginFormPrePersist, IPluginFormPreProcess, IPluginFormPreRender, IPluginFormPreRespond, IPluginFormPreview, IPluginFormRenderCallback, IPluginFormReplacer, IPluginFormResource, IPluginGeneric, IPluginMailEncryption, IPluginMalwareScanner, IPluginMenuEntries, IPluginMonitor, IPluginPortal, IPluginProcessing, IPluginProjectMenu, IPluginProjectTemplate, IPluginScopeClient, IPluginScopeSystem, IPluginServletAction, IPluginSessionReplacer, IPluginShutdown, IPluginStaticResourceServletAction, IPluginSystemReplacer, IPluginTemplateReplacer, IPluginTriggerHandler<TData>, IPluginValidationRule, IPluginWorkflowElementPrototypes, IPluginWorkflowNode, IPluginWorkflowTrigger
All Known Implementing Classes:
AFCPlugin, APluginActionNodeHandler, APluginConditionNodeHandler, APluginStaticResourceServletAction, APluginTriggerHandler
public interface IFCPlugin extends ITransferable, INameProviding, INamedUiElement
Base interface that all formcycle plugins must implement. This interface also contains the callback methods for the plugin lifecycle, which is as follows: Also, each time a user changes the plugin configuration (IPluginDefaultLifecycleData.getProperties(), the plugin is deactivated and then activated again. This also means that while a plugin is active, its configuration cannot change and must not be modified.
Author:
XIMA MEDIA GmbH

  • Field Details

  • Method Details

    • initialize

      default void initialize(IPluginInitializeData initializeData) throws FCPluginException
      Callback method that is invoked when this plugin is initialized.
      Parameters:
      initializeData - IPluginInitializeData
      Throws:
      FCPluginException - May be thrown when an error occurred during the initialization process. When an error is thrown, this plugin will be deactivated and not put into service.

    • shutdown

      default void shutdown(IPluginShutdownData shutdownData) throws FCPluginException
      Callback method that is invoked when this plugin is shut down.
      Parameters:
      shutdownData - IPluginShutdownData
      Throws:
      FCPluginException - May be throw when an error occurred during the shutdown process. Note that throwing an error will not prevent the plugin from being shut down.

    • uninstall

      default void uninstall(IPluginUninstallData uninstallData) throws FCPluginException
      Callback method that is invoked when this plugin is uninstalled.
      Parameters:
      uninstallData - IPluginUninstallData
      Throws:
      FCPluginException - May be thrown when an error occurred during the uninstall process. Note that throwing an error will not prevent the plugin from being uninstalled.

    • install

      default void install(IPluginInstallData installData) throws FCPluginException
      Callback method that is invoked when this plugin is installed.
      Parameters:
      installData - IPluginInstallData
      Throws:
      FCPluginException - May be thrown when an error occurred during the installation process. When an error is thrown, the plugin will be deactivated and not put into service.

    • getName

      String getName()
      Getter for the name of this plugin. This name may appear on the user interface.
      Specified by:
      getName in interface INameProviding
      Returns:
      String The name of this plugin.

    • getDescription

      default String getDescription(Locale locale)
      Getter for the description of this plugin. This description is shown on the user interface. This description may contain HTML markup.
      Parameters:
      locale - The locale for which to get the description.
      Returns:
      An HTML markup string with the description for this plugin, or null if no description is available.

    • getDisplayName

      default String getDisplayName(Locale locale)
      Specified by:
      getDisplayName in interface INamedUiElement
      Returns:
      Wert, der das entsprechende Objekt an Oberfläche repräsentiert (wird i.A. zur Laufzeit ermittelt).

    • validateConfigurationData

      default IPluginInitializeValidationResult validateConfigurationData(IPluginValidationData configData)
      Callback method that is invoked when a plugin is initialized, such as when the plugin is installed or when the formcycle server is started. This method lets you perform custom validation logic on the plugin configuration, such as checking whether a configured URL is reachable.

      If validation fails, the plugin will not be installed, saved, or updated. The user must correct the invalid configuration before the plugin can be installed, saved, or updated.

      Parameters:
      configData - Configuration data of the plugin
      Returns:
      The validation result, including whether the plugin configuration is valid and a list of validation error messages. null indicates no errors.
      Throws:
      RuntimeException - When an unexpected error occurred during validation. If this method throws an exception, this is treated as if an invalid validation result had been returned.

    • getDescription

      @Deprecated default String getDescription()
      Deprecated.
      Use getDescription(Locale)
      Returns:
      An HTML markup string with the description for this plugin, or null if no description is available.

    • initPlugin

      @Deprecated default void initPlugin() throws FCPluginException
      Deprecated.
      use initialize(IPluginInitializeData)
      Throws:
      FCPluginException - May be thrown when an error occurred during the initialization process. When an error is thrown, this plugin will be deactivated and not put into service.

    • shutdown

      @Deprecated default void shutdown()
      Deprecated.
      use shutdown(IPluginShutdownData)