Pre-response

Content [ Hide ]

Interface IPluginFormPreRespond
- Use cases
- Method signature
Parameters
Return value

Interface IPluginFormPreRespond

Position of pre-response page plugins in Xima® Formcycle's program flow. They are run before a response page is shown to the user after submitting a form.

Use cases

Displaying a blank response page
Retrieving the response page from another web service

When multiple pre-response page plugins are installed, their order of execution is arbitrary. You should not rely on a certain fixed order.

Pre-response page plugins are run for all forms of the client they belong to, or for all existing forms when installed as a system plugin. We recommend you check whether the plugin should be executed for the current form, for example by defining a plugin property containing a list of allowed forms.

Method signature

IPluginFormPreRespondRetVal execute(IPluginFormPreRespondParams params) throws FCPluginException

Parameters

An object of type IPluginFormPreRespondParams will be passed to the execute method, providing access to an object of type IFormRequestContext. A form request context provides you with access to many properties of the submitted form, including:

the current project (getProjekt())
the current client ((getMandant())
the current form record (getVorgang())
the current version of the form and all form fields (getFormVersion())
session attributes (getSessionAttributes())
the current user context for access to the database (getUserContext())

Return value

The execute method must return an object implementing IPluginFormPreRespondRetVal.

The class PluginGenericFormProcessingRetVal provides a reference implementation. Its constructor takes the boolean flag continueProcessing.

true
The form will be processed further.
false
The form will not be processed any further.

Tags: