de.xima.fc.plugin.interfaces

Interface IFCPlugin

All Superinterfaces:

ITransferable, Serializable

All Known Subinterfaces:

IDescriptionProvidingPlugin, IPluginConfigParamList, IPluginCustomGUI, IPluginDataSource, IPluginFormPrePersist, IPluginFormPreProcess, IPluginFormPreRender, IPluginFormPreRespond, IPluginFormPreview, IPluginFormReplacer, IPluginGeneric, IPluginProcessing, IPluginProjectTemplate, IPluginServletAction, IPluginSessionReplacer, IPluginShutdown, IPluginSystemReplacer, IPluginTemplateReplacer, IPluginValidationRule

All Known Implementing Classes:

AFCPlugin

public interface IFCPlugin
extends ITransferable

Interface für FormCycle-Plugins

Author:

xima media GmbH, Dresden - Michael Kohlsche - 12.04.2014

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_FILENAME

Method Summary

Modifier and Type	Method and Description
default String	getDescription() Eine allgemeine Beschreibung zur Funktionsweise des Plugins, welche dem Nutzer in der FORMCYCLE Oberfläche angezeigt wird.
String	getName() Getter für den Namen der Plugin-Verarbeitung
void	initPlugin() Methode zum Initialisieren des Plugins
default void	shutdown() Methode zum Ausführen von Busineslogik beim Entfernen des Plugins aus der Plugin-Registrierung

Field Detail

CONFIG_FILENAME

static final String CONFIG_FILENAME

See Also:

Constant Field Values

Method Detail

initPlugin

void initPlugin()
         throws FCPluginException

Methode zum Initialisieren des Plugins

Throws:

FCPluginException - Bei Fehlern in der Initialisierung des Plugins

getName

String getName()

Getter für den Namen der Plugin-Verarbeitung

Returns:

getDescription

default String getDescription()

Eine allgemeine Beschreibung zur Funktionsweise des Plugins, welche dem Nutzer in der FORMCYCLE Oberfläche angezeigt wird.
Hinweis: Um eine Formatierung des Bescheibungstextes zu ermöglichen, kann der Beschreibungstext mit HTML-Tags versehen werden.

Returns:

eine Zeichenkette oder null

shutdown

default void shutdown()

Methode zum Ausführen von Busineslogik beim Entfernen des Plugins aus der Plugin-Registrierung