de.xima.fc.plugin.interfaces

Interface IFCPlugin

All Superinterfaces:

INameProviding, ITransferable, Serializable

All Known Subinterfaces:

IDescriptionProvidingPlugin, IFCRemoteSyncPlugin, IPluginConfigParamList, IPluginCustomGUI, IPluginDataSource, IPluginFormElementCatalogue, IPluginFormElementWidget, IPluginFormPrePersist, IPluginFormPreProcess, IPluginFormPreRender, IPluginFormPreRespond, IPluginFormPreview, IPluginFormReplacer, IPluginFormResource, IPluginGeneric, IPluginMonitor, IPluginPortal, IPluginProcessing, IPluginProjectTemplate, IPluginServletAction, IPluginSessionReplacer, IPluginShutdown, IPluginSystemReplacer, IPluginTemplateReplacer, IPluginValidationRule

All Known Implementing Classes:

AFCPlugin

public interface IFCPlugin
extends ITransferable, INameProviding

Main-Interface for all FORMCYCLE-plugins

Author:

XIMA MEDIA GmbH, Dresden - Michael Kohlsche - 27.09.2017

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_FILENAME Deprecated.

Fields inherited from interface de.xima.fc.entities.interfaces.INameProviding

ATTR_NAME

Method Summary

Modifier and Type	Method and Description
default String	getDescription() Description of the plugin which will be displayed in the corresponding ui.
String	getName() Getter for the plugin-name
default void	initialize(IPluginInitializeData initializeData) Method to initialize an plugin
default void	initPlugin() Deprecated. use initialize(IPluginInitializeData)
default void	install(IPluginInstallData installData) Method which is invoked while installing an plugin
default void	shutdown() Deprecated. use shutdown(IPluginShutdownData)
default void	shutdown(IPluginShutdownData shutdownData) Method which will be invoked while shutting down an plugin
default void	uninstall(IPluginUninstallData uninstallData) Method which is invoked while deleting an plugin

Field Detail

CONFIG_FILENAME

@Deprecated
static final String CONFIG_FILENAME

Deprecated.

See Also:

Constant Field Values

Method Detail

initialize

default void initialize(IPluginInitializeData initializeData)
                 throws FCPluginException

Method to initialize an plugin

Parameters:

initializeData - IPluginInitializeData

Throws:

FCPluginException - on errors while initialization

shutdown

default void shutdown(IPluginShutdownData shutdownData)
               throws FCPluginException

Method which will be invoked while shutting down an plugin

Parameters:

shutdownData - IPluginShutdownData

Throws:

FCPluginException - on errors while shutdown

uninstall

default void uninstall(IPluginUninstallData uninstallData)
                throws FCPluginException

Method which is invoked while deleting an plugin

Parameters:

uninstallData - IPluginUninstallData

Throws:

FCPluginException - on errors while deleting

install

default void install(IPluginInstallData installData)
              throws FCPluginException

Method which is invoked while installing an plugin

Parameters:

installData - IPluginInstallData

Throws:

FCPluginException - on errors while installation

getName

String getName()

Getter for the plugin-name

Specified by:

getName in interface INameProviding

Returns:

String plugin-name

getDescription

default String getDescription()

Description of the plugin which will be displayed in the corresponding ui. This description can use HTML

Returns:

String or null

initPlugin

@Deprecated
default void initPlugin()
                             throws FCPluginException

Deprecated. use initialize(IPluginInitializeData)

Throws:

FCPluginException

shutdown

@Deprecated
default void shutdown()

Deprecated. use shutdown(IPluginShutdownData)