All Known Implementing Classes:

WorkflowTaskRunnerParams
```
public interface IWorkflowTaskRunnerParams
```
Data required for executing a workflow task, such as the client, user, and locale.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Mandant`	`getClient()`
`EWorkflowStateType`	`getDefaultSystemState()`
`IFormDataAdapter`	`getFormDataAdapter()`
`Vorgang`	`getFormRecord()`
`IHttpContextData`	`getHttpContextData()`
`Locale`	`getLocale()`
`Projekt`	`getProject()`
`Benutzer`	`getUser()`
`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.

- Method Detail
  - getClient
```
@Nonnull
Mandant getClient()
```
    Returns:
    
    The current client. This is required and must not be null.
  - getDefaultSystemState
```
@Nonnull
EWorkflowStateType getDefaultSystemState()
```
    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
```
@Nonnull
IFormDataAdapter getFormDataAdapter()
```
    Returns:
    
    The adapter containing the form data of the form record.
  - getFormRecord
```
@Nonnull
Vorgang getFormRecord()
```
    Returns:
    
    Form record for which a task is to be executed.
  - getHttpContextData
```
@Nonnull
IHttpContextData getHttpContextData()
```
    Returns:
    
    Data of the current HTTP request. When no HTTP request is active, this will contain dummy data.
  - getLocale
```
@Nonnull
Locale getLocale()
```
    Returns:
    
    Locale to use for locale-sensitive operations.
  - getProject
```
@Nonnull
Projekt getProject()
```
    Returns:
    
    The project to which the task belongs that is to be executed.
  - getUser
```
@Nonnull
Benutzer getUser()
```
    Returns:
    
    The user who initiated the workflow execution. May be an anonymous or system user, but must not be null.
  - getWorkflowVersion
```
@Nonnull
WorkflowVersion getWorkflowVersion()
```
    Returns:
    
    The workflow version of the Projekt.getWorkflowVersions() that is to be executed.
  - getXForm
```
@Nonnull
IXForm getXForm()
```
    Returns:
    
    The form belonging to the form record.
  - getXFormRenderConfig
```
@Nonnull
IXFormRenderConfig getXFormRenderConfig()
```
    Returns:
    
    The configuration that was used to render the form.
  - isAnonymize
```
Boolean isAnonymize()
```
    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
```
boolean isUnsafeSkipFormRecordLock()
```
    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.
    
    Returns:
    
    true to skip locking, or false to lock the form record for exclusive use before executing a task.

Interface IWorkflowTaskRunnerParams

Method Summary

Method Detail

getClient

getDefaultSystemState

getFormDataAdapter

getFormRecord

getHttpContextData

getLocale

getProject

getUser

getWorkflowVersion

getXForm

getXFormRenderConfig

isAnonymize

isUnsafeSkipFormRecordLock