java.lang.Object
- de.xima.fc.workflow.event.FormSubmissionEventDataBuilder

All Implemented Interfaces:

org.apache.commons.lang3.builder.Builder<IFormSubmissionEvent>
```
public class FormSubmissionEventDataBuilder
extends Object
```
Builder for the event data for a form submission event, i.e. when the user clicked on a submit button. Create an instance via the methods of WorkflowEventDataFactory.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Field Summary

Fields
Modifier and Type	Field	Description
`protected Boolean`	`anonymize`
`protected Clock`	`clock`
`protected Vorgang`	`formRecord`
`protected IFormRecordLockContext`	`formRecordLockContext`
`protected Locale`	`locale`
`protected IUser`	`user`
`protected List<IWorkflowExecutionPostProcessor>`	`workflowExecutionPostProcessors`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`TThis`	`addWorkflowExecutionPostProcessor(IWorkflowExecutionPostProcessor workflowExecutionPostProcessor)`
`TThis`	`anonymize(Boolean anonymize)`
`IFormSubmissionEvent`	`build()`
`FormSubmissionEventDataBuilder`	`client(Mandant client)`
`TThis`	`clock(Clock clock)`
`FormSubmissionEventDataBuilder`	`defaultSystemState(EWorkflowStateType defaultSytemState)`	Deprecated. Add a post processor via `AFormRecordEventDataBuilder.addWorkflowExecutionPostProcessor(IWorkflowExecutionPostProcessor)`.
`FormSubmissionEventDataBuilder`	`formDataAdapter(IFormDataAdapter formDataAdapter)`
`TThis`	`formRecordLockContext(IFormRecordLockContext formRecordLockContext)`
`protected FormSubmissionEventDataBuilder`	`getThis()`
`FormSubmissionEventDataBuilder`	`httpContextData(IHttpContextData httpContextData)`
`TThis`	`locale(Locale locale)`
`FormSubmissionEventDataBuilder`	`project(Projekt project)`
`FormSubmissionEventDataBuilder`	`submitButton(String submitButton)`
`FormSubmissionEventDataBuilder`	`submitButtonQualifier(String submitButtonQualifier)`
`TThis`	`user(Benutzer user)`	Deprecated. Use `user(IUser)` instead.
`TThis`	`user(IUser user)`
`TThis`	`workflowExecutionPostProcessors(Iterable<IWorkflowExecutionPostProcessor> workflowExecutionPostProcessors)`
`FormSubmissionEventDataBuilder`	`xForm(IXForm xForm)`
`FormSubmissionEventDataBuilder`	`xFormRenderConfig(IXFormRenderConfig xFormRenderConfig)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - anonymize
```
protected Boolean anonymize
```
  - clock
```
protected Clock clock
```
  - formRecord
```
protected final Vorgang formRecord
```
  - formRecordLockContext
```
protected IFormRecordLockContext formRecordLockContext
```
  - locale
```
protected Locale locale
```
  - user
```
protected IUser user
```
  - workflowExecutionPostProcessors
```
protected List<IWorkflowExecutionPostProcessor> workflowExecutionPostProcessors
```
- Method Detail
  - build
```
public IFormSubmissionEvent build()
```
  - client
```
public FormSubmissionEventDataBuilder client(Mandant client)
```
    Parameters:
    
    client - The client that owns the submitted form. When not set explicitly, the client is taken from the form.
    
    Returns:
    
    This builder instance for chaining method calls.
  - defaultSystemState
```
@Deprecated
public FormSubmissionEventDataBuilder defaultSystemState(EWorkflowStateType defaultSytemState)
```
    Deprecated.
    Add a post processor via AFormRecordEventDataBuilder.addWorkflowExecutionPostProcessor(IWorkflowExecutionPostProcessor).
    
    Parameters:
    
    defaultSytemState - The default state that is set when the form record has not state and no state was set by the executed workflow tasks.
    
    Returns:
    
    This builder instance for chaining method calls.
  - formDataAdapter
```
public FormSubmissionEventDataBuilder formDataAdapter(IFormDataAdapter formDataAdapter)
```
    Parameters:
    
    formDataAdapter - The form data adapter with the form data that should be used.
    
    Returns:
    
    This builder instance for chaining method calls.
  - httpContextData
```
public FormSubmissionEventDataBuilder httpContextData(IHttpContextData httpContextData)
```
    Parameters:
    
    httpContextData - The HTTP context where the workflow is executed. When not given, actions that require an HTTP context are not available, such as responding with an HTML template.
    
    Returns:
    
    This builder for chaining method calls.
  - project
```
public FormSubmissionEventDataBuilder project(Projekt project)
```
    Parameters:
    
    project - The project of the form record. When not specified explicitly, retrieves the project from the form record.
    
    Returns:
    
    This builder for chaining method calls.
  - submitButton
```
public FormSubmissionEventDataBuilder submitButton(String submitButton)
```
    Parameters:
    
    submitButton - Submit button that was used to submit the form. When not set explicitly, the submit button is read from the formDataAdapter(IFormDataAdapter).
    
    Returns:
    
    This builder instance for chaining method calls.
  - submitButtonQualifier
```
public FormSubmissionEventDataBuilder submitButtonQualifier(String submitButtonQualifier)
```
    Parameters:
    
    submitButtonQualifier - Qualifier of the submit button that was used to submit the form. When not set explicitly, the submit button is read from the formDataAdapter(IFormDataAdapter).
    
    Returns:
    
    This builder instance for chaining method calls.
  - xForm
```
public FormSubmissionEventDataBuilder xForm(IXForm xForm)
```
    Parameters:
    
    xForm - The form model of the form record. When not specified explicitly, retrieves the model from the current form version of the form record.
    
    Returns:
    
    This builder for chaining method calls.
  - xFormRenderConfig
```
public FormSubmissionEventDataBuilder xFormRenderConfig(IXFormRenderConfig xFormRenderConfig)
```
    Parameters:
    
    xFormRenderConfig - The form render config of the form record. When not specified explicitly, retrieves the model from the current form version of the form record.
    
    Returns:
    
    This builder for chaining method calls.
  - getThis
```
protected FormSubmissionEventDataBuilder getThis()
```
  - addWorkflowExecutionPostProcessor
```
public TThis addWorkflowExecutionPostProcessor(IWorkflowExecutionPostProcessor workflowExecutionPostProcessor)
```
  - anonymize
```
public TThis anonymize(Boolean anonymize)
```
  - clock
```
public TThis clock(Clock clock)
```
  - formRecordLockContext
```
public TThis formRecordLockContext(IFormRecordLockContext formRecordLockContext)
```
  - locale
```
public TThis locale(Locale locale)
```
  - user
```
public TThis user(IUser user)
```
  - workflowExecutionPostProcessors
```
public TThis workflowExecutionPostProcessors(Iterable<IWorkflowExecutionPostProcessor> workflowExecutionPostProcessors)
```
  - user
```
@Deprecated
public TThis user(Benutzer user)
```
    Deprecated.
    Use user(IUser) instead.
    
    Parameters:
    
    user - The user who started the workflow.
    
    Returns:
    
    This builder instance for chaining method calls.

Class FormSubmissionEventDataBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

anonymize

clock

formRecord

formRecordLockContext

locale

user

workflowExecutionPostProcessors

Method Detail

build

client

defaultSystemState

formDataAdapter

httpContextData

project

submitButton

submitButtonQualifier

xForm

xFormRenderConfig

getThis

addWorkflowExecutionPostProcessor

anonymize

clock

formRecordLockContext

locale

user

workflowExecutionPostProcessors

user