de.xima.fc.plugin.interfaces.form

Interface IPluginFormPrePersist

All Superinterfaces:

IFCPlugin, INamedUiElement, INameProviding, ITransferable, Serializable

public interface IPluginFormPrePersist
extends IFCPlugin

Interface for form pre-persist plugins. This plugin is executed when a form was submitted, but before a FormEingang is created and the form data is saved to the database. Contrast this with a plugin of type IPluginFormPreProcess, which is run after a FormEingang was created; and to IPluginFormPreRespond, which is run after the workflow was processed as well.

This plugin offers the option to add an custom check whether the form submission should be prevented or not. When this plugin prevents the form submission, the submitted form data is discarded and no form record is created. The workflow is then not run either.

Author:

XIMA MEDIA GmbH

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, COL_NAME

Fields inherited from interface de.xima.fc.interfaces.INamedUiElement

ATTR_DISPLAY_NAME

Method Summary

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

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

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

Method Detail

execute

IPluginFormPrePersistRetVal execute(IPluginFormPrePersistParams params)
                             throws FCPluginException

The main method of this plugin. Checks and returns whether the form submission is acceptable.

When any exception other than FCPluginException is thrown, the form will not be persisted and a general error template is returned to the user who submitted the form.

Parameters:

params - The parameters this plugin may make use of. Contains the current form request context that may be used to access the submitted form data.

Returns:

Whether the form submission should be allowed or prevented.

Throws:

FCPluginException - May be thrown when this plugin cannot perform its task due to any reason. If this exception is thrown, the form will still be persisted.