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 ofIPluginFormPreRespondParams
.- 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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description IFormRequestContext
getFormRequestContext()
Map<Serializable,Serializable>
getFrqSessionAttributeMap()
Gets the values stored in the currentFRQSession
.com.alibaba.fastjson.JSONObject
getLdapUserData()
Deprecated.Map<String,Serializable>
getSessionAttributeMap()
Gets the values from the currentHttpSession
.IRemoteEventExecutionResult
getTaskExecutionResult()
A pre-respond plugin is executed after the workflow engine was run.com.alibaba.fastjson.JSONObject
getUserData()
Vorgang
getVorgang()
IWorkflowResponse
getWorkflowResponse()
Deprecated.
-
-
-
Constructor Detail
-
PluginFormPreRespondParams
public PluginFormPreRespondParams(IFormRequestContext context, Vorgang vorgang, IWorkflowResponse response, IRemoteEventExecutionResult taskExecutionResult)
Creates a new POJO with the given data.- Parameters:
context
- The value forIPluginFormPreRespondParams.getFormRequestContext()
vorgang
- The value forIPluginFormPreRespondParams.getVorgang()
response
- The value forIPluginFormPreRespondParams.getWorkflowResponse()
taskExecutionResult
- The value forIPluginFormPreRespondParams.getTaskExecutionResult()
-
-
Method Detail
-
getFormRequestContext
public IFormRequestContext getFormRequestContext()
- Specified by:
getFormRequestContext
in interfaceIFormLifecycleExecuteParams
- Specified by:
getFormRequestContext
in interfaceIPluginFormPreRespondParams
- 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 executedWorkflowTask
were combined.- Specified by:
getTaskExecutionResult
in interfaceIPluginFormPreRespondParams
- Returns:
- The combined result from the workflow execution.
-
getVorgang
public Vorgang getVorgang()
- Specified by:
getVorgang
in interfaceIPluginFormPreRespondParams
- 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 existingVorgang
.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 interfaceIPluginFormPreRespondParams
- Returns:
- The result from the workflow execution.
-
getUserData
public com.alibaba.fastjson.JSONObject getUserData()
- Specified by:
getUserData
in interfaceIFormLifecycleExecuteParams
- Specified by:
getUserData
in interfaceIPluginFormPreRespondParams
- Returns:
- A
JSONObject
with the current data for the authenticated user. When the current form does not require authorization, this may return an emptyJSONObject
-
getLdapUserData
@Deprecated public com.alibaba.fastjson.JSONObject getLdapUserData()
Deprecated.- Specified by:
getLdapUserData
in interfaceIFormLifecycleExecuteParams
- Specified by:
getLdapUserData
in interfaceIPluginFormPreRespondParams
- 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 emptyJSONObject
-
getFrqSessionAttributeMap
public Map<Serializable,Serializable> getFrqSessionAttributeMap()
Description copied from interface:IFormLifecycleExecuteParams
Gets the values stored in the currentFRQSession
. 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 theFRQSession
. To modify the FRQ session attributes, use theIPluginFormPrePersistRetVal.getFrqSessionAttributeMap()
return value.- Specified by:
getFrqSessionAttributeMap
in interfaceIFormLifecycleExecuteParams
- 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 currentHttpSession
. 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 theHttpSession
. To modify the session attributes, use theIPluginFormPreRenderRetVal.getSessionAttributes()
return value.- Specified by:
getSessionAttributeMap
in interfaceIFormLifecycleExecuteParams
- Returns:
- A map
Map
with all attributes of the currentHttpSession
.
-
-