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
implements org.apache.commons.lang3.builder.Builder<IFormSubmissionEvent>

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

Method Summary

Modifier and Type	Method	Description
FormSubmissionEventDataBuilder	anonymize(Boolean anonymize)
IFormSubmissionEvent	build()
FormSubmissionEventDataBuilder	client(Mandant client)
FormSubmissionEventDataBuilder	defaultSystemState(EWorkflowStateType defaultSytemState)
FormSubmissionEventDataBuilder	formDataAdapter(IFormDataAdapter formDataAdapter)
FormSubmissionEventDataBuilder	formRecordLockContext(IFormRecordLockContext formRecordLockContext)
FormSubmissionEventDataBuilder	httpContextData(IHttpContextData httpContextData)
FormSubmissionEventDataBuilder	locale(Locale locale)
FormSubmissionEventDataBuilder	project(Projekt project)
FormSubmissionEventDataBuilder	submitButton(String submitButton)
FormSubmissionEventDataBuilder	submitButtonQualifier(String submitButtonQualifier)
FormSubmissionEventDataBuilder	user(Benutzer user)
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

Method Detail

anonymize

public FormSubmissionEventDataBuilder anonymize(Boolean anonymize)

build

public IFormSubmissionEvent build()

Specified by:

build in interface org.apache.commons.lang3.builder.Builder<IFormSubmissionEvent>

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 not state and no state was set by the executed workflow tasks.

Returns:

This builder instance 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.

formDataAdapter

public FormSubmissionEventDataBuilder formDataAdapter(IFormDataAdapter formDataAdapter)

Parameters:

the - context that is locking the form record.

Returns:

This builder instance for chaining method calls.

formRecordLockContext

public FormSubmissionEventDataBuilder formRecordLockContext(IFormRecordLockContext formRecordLockContext)

Parameters:

formDataAdapter - Deserialized form data. When given and no submitButton(String) is set explicitly, the submit button is read from this form data adapter.

Returns:

This builder instance for chaining method calls.

httpContextData

public FormSubmissionEventDataBuilder httpContextData(IHttpContextData httpContextData)

locale

public FormSubmissionEventDataBuilder locale(Locale locale)

project

public FormSubmissionEventDataBuilder project(Projekt project)

user

public FormSubmissionEventDataBuilder user(Benutzer user)

xForm

public FormSubmissionEventDataBuilder xForm(IXForm xForm)

xFormRenderConfig

public FormSubmissionEventDataBuilder xFormRenderConfig(IXFormRenderConfig xFormRenderConfig)