de.xima.fc.plugin.interfaces.form

Interface IPluginFormPreProcess

All Superinterfaces:

IFCPlugin, INameProviding, ITransferable, Serializable

public interface IPluginFormPreProcess
extends IFCPlugin

Interface for a form pre-process plugin. This plugin is executed when the form is submitted, after a FormEingang with the submitted form values was created and just before the workflow processing is about to start. Contrast this with a plugin of type IPluginFormPrePersist, which is run before a FormEingang is created; and to IPluginFormPreRespond, which is run after the workflow was processed.

This plugin may prevent the workflow from being executed, in which case the a generic error page is returned to the user. You might use this plugin to have the submitted form data saved to the database, but prevent the workflow from being executed, or you could perform additional business logic.

Author:

XIMA MEDIA GmbH, Dresden - Michael Kohlsche - 24.08.2015

Field Summary

Fields inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

CONFIG_FILENAME

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

ATTR_NAME

Method Summary

Modifier and Type	Method and Description
IPluginFormPreProcessRetVal	execute(IPluginFormPreProcessParams params) The main method of this plugin.

Methods inherited from interface de.xima.fc.plugin.interfaces.IFCPlugin

getDescription, getName, initialize, initPlugin, install, shutdown, shutdown, uninstall

Method Detail

execute

IPluginFormPreProcessRetVal execute(IPluginFormPreProcessParams params)
                             throws FCPluginException

The main method of this plugin. Performs any additional actions before workflow processing starts.

Parameters:

params - The parameters this plugin may make use of. Gives you access, for example, to the current Vorgang, or the current Projekt.

Returns:

Whether the workflow processing should be run. If it is not run, a generic error page is returned to the user.

Throws:

FCPluginException - May be thrown when this plugin cannot perform is task due to any reason. Please note that throwing this exception will not prevent the workflow from being run.