Package de.xima.fc.workflow.model

Class WorkflowTaskRunnerParams

java.lang.Object

de.xima.fc.workflow.model.WorkflowTaskRunnerParams

All Implemented Interfaces:

IWorkflowTaskRunnerParams

public final class WorkflowTaskRunnerParams
extends Object
implements IWorkflowTaskRunnerParams

POJO implementation of IWorkflowTaskRunnerParams with a builder.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	WorkflowTaskRunnerParams.Builder	A builder for creating the IWorkflowTaskRunnerParams.

Method Summary

Modifier and Type	Method	Description
static WorkflowTaskRunnerParams.Builder	builder(Vorgang formRecord)
Mandant	getClient()
Clock	getClock()
EWorkflowStateType	getDefaultSystemState()
IFormDataAdapter	getFormDataAdapter()
Vorgang	getFormRecord()
IFormRecordLockContext	getFormRecordLockContext()
IHttpContextData	getHttpContextData()
Locale	getLocale()
Projekt	getProject()
Benutzer	getUser()	Deprecated. Use getUserModel() instead.
IUser	getUserModel()
Iterable<IWorkflowExecutionPostProcessor>	getWorkflowExecutionPostProcessors()	Callback that is invoked after the workflow was executed.
WorkflowVersion	getWorkflowVersion()
IXForm	getXForm()
IXFormRenderConfig	getXFormRenderConfig()
Boolean	isAnonymize()
boolean	isUnsafeSkipFormRecordLock()	Whether the form record should be locked for exclusive use, to ensure that a form record is not processed by multiple threads.

Methods inherited from class java.lang.Object

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

Method Details

getClient

public Mandant getClient()

Specified by:

getClient in interface IWorkflowTaskRunnerParams

Returns:

The current client. This is required and must not be null.

getClock

public Clock getClock()

Specified by:

getClock in interface IWorkflowTaskRunnerParams

Returns:

The clock to use for obtaining the current time.

getDefaultSystemState

public EWorkflowStateType getDefaultSystemState()

Specified by:

getDefaultSystemState in interface IWorkflowTaskRunnerParams

Returns:

The default state to be set on a form record when, after workflow processing is complete, the Vorgang.getCurrentWorkflowState() is still null. Must not be EWorkflowStateType.CUSTOM (as that is not a system state).

getFormDataAdapter

public IFormDataAdapter getFormDataAdapter()

Specified by:

getFormDataAdapter in interface IWorkflowTaskRunnerParams

Returns:

The adapter containing the form data of the form record.

getFormRecord

public Vorgang getFormRecord()

Specified by:

getFormRecord in interface IWorkflowTaskRunnerParams

Returns:

Form record for which a task is to be executed.

getFormRecordLockContext

public IFormRecordLockContext getFormRecordLockContext()

Specified by:

getFormRecordLockContext in interface IWorkflowTaskRunnerParams

Returns:

the context that is locking the form record. May be null

getHttpContextData

public IHttpContextData getHttpContextData()

Specified by:

getHttpContextData in interface IWorkflowTaskRunnerParams

Returns:

Data of the current HTTP request. When no HTTP request is active, this will contain dummy data.

getLocale

public Locale getLocale()

Specified by:

getLocale in interface IWorkflowTaskRunnerParams

Returns:

Locale to use for locale-sensitive operations.

getProject

public Projekt getProject()

Specified by:

getProject in interface IWorkflowTaskRunnerParams

Returns:

The project to which the task belongs that is to be executed.

getUser

@Deprecated
public Benutzer getUser()

Deprecated.

Use getUserModel() instead.

Specified by:

getUser in interface IWorkflowTaskRunnerParams

Returns:

The user who initiated the workflow.

getUserModel

public IUser getUserModel()

Specified by:

getUserModel in interface IWorkflowTaskRunnerParams

Returns:

The user who initiated the workflow execution. May be an anonymous or system user, but must not be null.

getWorkflowExecutionPostProcessors

public Iterable<IWorkflowExecutionPostProcessor> getWorkflowExecutionPostProcessors()

Description copied from interface: IWorkflowTaskRunnerParams

Callback that is invoked after the workflow was executed. Lets you modify the workflow execution state before the final result is created.

Specified by:

getWorkflowExecutionPostProcessors in interface IWorkflowTaskRunnerParams

Returns:

Post processor to apply, may be null or empty.

getWorkflowVersion

public WorkflowVersion getWorkflowVersion()

Specified by:

getWorkflowVersion in interface IWorkflowTaskRunnerParams

Returns:

The workflow version of the Projekt.getWorkflowVersions() that is to be executed.

getXForm

public IXForm getXForm()

Specified by:

getXForm in interface IWorkflowTaskRunnerParams

Returns:

The form belonging to the form record.

getXFormRenderConfig

public IXFormRenderConfig getXFormRenderConfig()

Specified by:

getXFormRenderConfig in interface IWorkflowTaskRunnerParams

Returns:

The configuration that was used to render the form.

isAnonymize

public Boolean isAnonymize()

Specified by:

isAnonymize in interface IWorkflowTaskRunnerParams

Returns:

true if data related to individual persons or users must be anonymized. When null, an appropriate default is used: (true when the Projekt.isAnonymize() requires it, or false otherwise.)

isUnsafeSkipFormRecordLock

public boolean isUnsafeSkipFormRecordLock()

Description copied from interface: IWorkflowTaskRunnerParams

Whether the form record should be locked for exclusive use, to ensure that a form record is not processed by multiple threads. This should normally be left at the default false.

Specified by:

isUnsafeSkipFormRecordLock in interface IWorkflowTaskRunnerParams

Returns:

true to skip locking, or false to lock the form record for exclusive use before executing a task.

builder

public static WorkflowTaskRunnerParams.Builder builder(Vorgang formRecord)

Parameters:

formRecord - Form record for which a task is to be executed. Must not be null.

Returns:

A new builder for executing a task of the given form record.