Package de.xima.fc.interfaces.plugin.param.form

Interface IPluginFormPreRespondParams

All Superinterfaces:
IFormLifecycleExecuteParams, IPluginParameters, Serializable
All Known Implementing Classes:
PluginFormPreRespondParams
public interface IPluginFormPreRespondParams extends IFormLifecycleExecuteParams, IPluginParameters, Serializable
Interface for the parameters of form pre-respond plugins.
Author:
XIMA MEDIA GmbH

  • Method Details

    • getFormRequestContext

      IFormRequestContext getFormRequestContext()
      Specified by:
      getFormRequestContext in interface IFormLifecycleExecuteParams
      Returns:
      The current form request context that may be used to access the submitted form data.

    • getVorgang

      Vorgang getVorgang()
      Returns:
      The current Vorgang, after the workflow was executed. It is newly created if the form was just submitted for the first time. When the form is resubmitted, this is the existing Vorgang.

      Note that this is the current form record with the modification performed during workflow execution. In contrast, IFormRequestContext.getVorgang() is the form record as it was when the form was submitted, without the modifications from the workflow.

    • getWorkflowResponse

      @Deprecated IWorkflowResponse getWorkflowResponse()
      Deprecated.
      This is the result from the old workflow engine, which scheduled to be removed soon. Use getTaskExecutionResult() for the new workflow.
      A pre-respond plugin is executed after the workflow was run. This method returns the result of that workflow processing.
      Returns:
      The result from the workflow execution.

    • getLdapUserData

      com.alibaba.fastjson.JSONObject getLdapUserData()
      Specified by:
      getLdapUserData in interface IFormLifecycleExecuteParams
      Returns:
      A JSONObject with the current LDAP data for the authenticated user. When the current form does not require authorization, or when the current user did not authorize via LDAP, this may return an empty JSONObject

    • getUserData

      com.alibaba.fastjson.JSONObject getUserData()
      Specified by:
      getUserData in interface IFormLifecycleExecuteParams
      Returns:
      A JSONObject with the current data for the authenticated user. When the current form does not require authorization, this may return an empty JSONObject

    • getTaskExecutionResult

      IRemoteEventExecutionResult getTaskExecutionResult()
      A pre-respond plugin is executed after the workflow engine was run. This is the result of that workflow execution, after the individual results of all executed WorkflowTask were combined.
      Returns:
      The combined result from the workflow execution.