Package de.xima.fc.workflow.event
Class FormSubmissionEventDataBuilder
- 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 ofWorkflowEventDataFactory
.- Since:
- 7.0.0
- Author:
- XIMA MEDIA GmbH
-
-
Field Summary
Fields Modifier and Type Field Description protected Boolean
anonymize
protected Vorgang
formRecord
protected IFormRecordLockContext
formRecordLockContext
protected Locale
locale
protected Benutzer
user
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TThis
anonymize(Boolean anonymize)
IFormSubmissionEvent
build()
FormSubmissionEventDataBuilder
client(Mandant client)
FormSubmissionEventDataBuilder
defaultSystemState(EWorkflowStateType defaultSytemState)
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)
FormSubmissionEventDataBuilder
xForm(IXForm xForm)
FormSubmissionEventDataBuilder
xFormRenderConfig(IXFormRenderConfig xFormRenderConfig)
-
-
-
Field Detail
-
anonymize
protected Boolean anonymize
-
formRecord
protected final Vorgang formRecord
-
formRecordLockContext
protected IFormRecordLockContext formRecordLockContext
-
locale
protected Locale locale
-
user
protected Benutzer user
-
-
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
public FormSubmissionEventDataBuilder defaultSystemState(EWorkflowStateType defaultSytemState)
- Parameters:
defaultSytemState
- The default state that is set when the form record has notstate
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 theformDataAdapter(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 theformDataAdapter(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()
-
anonymize
public TThis anonymize(Boolean anonymize)
-
formRecordLockContext
public TThis formRecordLockContext(IFormRecordLockContext formRecordLockContext)
-
locale
public TThis locale(Locale locale)
-
user
public TThis user(Benutzer user)
-
-