Package de.xima.fc.plugin.models.params.form

Class PluginFormPreRespondParams

java.lang.Object

de.xima.fc.plugin.models.params.form.PluginFormPreRespondParams

All Implemented Interfaces:

IPluginParameters, IFormLifecycleExecuteParams, IPluginFormPreRespondParams, Serializable

public class PluginFormPreRespondParams
extends Object
implements IPluginFormPreRespondParams

Simple POJO implementation of IPluginFormPreRespondParams.

Author:

XIMA MEDIA GmbH

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PluginFormPreRespondParams(IFormRequestContext context, Vorgang vorgang, IWorkflowResponse response, IRemoteEventExecutionResult taskExecutionResult)	Creates a new POJO with the given data.

Method Summary

Modifier and Type	Method	Description
IFormRequestContext	getFormRequestContext()
Map<Serializable,Serializable>	getFrqSessionAttributeMap()	Gets the values stored in the current FRQSession.
com.alibaba.fastjson.JSONObject	getLdapUserData()	Deprecated.
Map<String,Serializable>	getSessionAttributeMap()	Gets the values from the current HttpSession.
IRemoteEventExecutionResult	getTaskExecutionResult()	A pre-respond plugin is executed after the workflow engine was run.
com.alibaba.fastjson.JSONObject	getUserData()
Vorgang	getVorgang()
IWorkflowResponse	getWorkflowResponse()	Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PluginFormPreRespondParams

public PluginFormPreRespondParams(IFormRequestContext context,
 Vorgang vorgang,
 IWorkflowResponse response,
 IRemoteEventExecutionResult taskExecutionResult)

Creates a new POJO with the given data.

Parameters:

context - The value for IPluginFormPreRespondParams.getFormRequestContext()

vorgang - The value for IPluginFormPreRespondParams.getVorgang()

response - The value for IPluginFormPreRespondParams.getWorkflowResponse()

taskExecutionResult - The value for IPluginFormPreRespondParams.getTaskExecutionResult()

Method Details

getFormRequestContext

public IFormRequestContext getFormRequestContext()

Specified by:

getFormRequestContext in interface IFormLifecycleExecuteParams

Specified by:

getFormRequestContext in interface IPluginFormPreRespondParams

Returns:

The current form request context that may be used to access the submitted form data.

getTaskExecutionResult

public IRemoteEventExecutionResult getTaskExecutionResult()

Description copied from interface: IPluginFormPreRespondParams

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.

Specified by:

getTaskExecutionResult in interface IPluginFormPreRespondParams

Returns:

The combined result from the workflow execution.

getVorgang

public Vorgang getVorgang()

Specified by:

getVorgang in interface IPluginFormPreRespondParams

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
public IWorkflowResponse getWorkflowResponse()

Deprecated.

Description copied from interface: IPluginFormPreRespondParams

A pre-respond plugin is executed after the workflow was run. This method returns the result of that workflow processing.

Specified by:

getWorkflowResponse in interface IPluginFormPreRespondParams

Returns:

The result from the workflow execution.

getUserData

public com.alibaba.fastjson.JSONObject getUserData()

Specified by:

getUserData in interface IFormLifecycleExecuteParams

Specified by:

getUserData in interface IPluginFormPreRespondParams

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

getLdapUserData

@Deprecated
public com.alibaba.fastjson.JSONObject getLdapUserData()

Deprecated.

Specified by:

getLdapUserData in interface IFormLifecycleExecuteParams

Specified by:

getLdapUserData in interface IPluginFormPreRespondParams

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

getFrqSessionAttributeMap

public Map<Serializable,Serializable> getFrqSessionAttributeMap()

Description copied from interface: IFormLifecycleExecuteParams

Gets the values stored in the current FRQSession. The servlet plugin may be executed on a different server that does not have direct access to the HTTP request: Please note that changes to this map are NOT reflected or saved in the FRQSession. To modify the FRQ session attributes, use the IPluginFormPrePersistRetVal.getFrqSessionAttributeMap() return value.

Specified by:

getFrqSessionAttributeMap in interface IFormLifecycleExecuteParams

Returns:

Attributes from the form request session of the current request. If no such session exists, this is an empty map.

getSessionAttributeMap

public Map<String,Serializable> getSessionAttributeMap()

Description copied from interface: IFormLifecycleExecuteParams

Gets the values from the current HttpSession. The servlet plugin may be executed on a different server that does not have direct access to the HTTP request: Please note that changes to this map are NOT reflected or saved in the HttpSession. To modify the session attributes, use the IPluginFormPreRenderRetVal.getSessionAttributes() return value.

Specified by:

getSessionAttributeMap in interface IFormLifecycleExecuteParams

Returns:

A map Map with all attributes of the current HttpSession.