Package de.xima.fc.workflow.iface
Interface IWorkflowTaskRunnerParams
-
- 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 Deprecated Methods Modifier and Type Method Description Mandant
getClient()
Clock
getClock()
EWorkflowStateType
getDefaultSystemState()
IFormDataAdapter
getFormDataAdapter()
Vorgang
getFormRecord()
IFormRecordLockContext
getFormRecordLockContext()
IHttpContextData
getHttpContextData()
Locale
getLocale()
Projekt
getProject()
Benutzer
getUser()
Deprecated.UsegetUserModel()
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()
Deprecated.UsegetFormRecordLockContext()
with a dummy context.
-
-
-
Method Detail
-
getClient
@Nullable Mandant getClient()
- Returns:
- The current client. This is required and must not be
null
.
-
getClock
@Nullable Clock getClock()
- Returns:
- The clock to use for obtaining the current time.
- Since:
- 8.0.0
-
getWorkflowExecutionPostProcessors
@Nullable Iterable<IWorkflowExecutionPostProcessor> getWorkflowExecutionPostProcessors()
Callback that is invoked after the workflow was executed. Lets you modify the workflow execution state before the final result is created.- Returns:
- Post processor to apply, may be
null
or empty. - Since:
- 7.0.11
-
getDefaultSystemState
@Nullable EWorkflowStateType getDefaultSystemState()
- Returns:
- The default state to be set on a form record when, after workflow processing is complete, the
Vorgang.getCurrentWorkflowState()
is stillnull
. Must not beEWorkflowStateType.CUSTOM
(as that is not a system state).
-
getFormDataAdapter
@Nullable 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.
-
getFormRecordLockContext
IFormRecordLockContext getFormRecordLockContext()
- Returns:
- the context that is locking the form record. May be
null
- Since:
- 7.0.5
-
getHttpContextData
@Nullable IHttpContextData getHttpContextData()
- Returns:
- Data of the current HTTP request. When no HTTP request is active, this will contain dummy data.
-
getLocale
@Nullable Locale getLocale()
- Returns:
- Locale to use for locale-sensitive operations.
-
getProject
@Nullable Projekt getProject()
- Returns:
- The project to which the task belongs that is to be executed.
-
getUserModel
@Nullable IUser getUserModel()
- Returns:
- The user who initiated the workflow execution. May be an anonymous or system user, but must not be
null
.
-
getWorkflowVersion
@Nullable WorkflowVersion getWorkflowVersion()
- Returns:
- The workflow version of the
Projekt.getWorkflowVersions()
that is to be executed.
-
getXForm
@Nullable IXForm getXForm()
- Returns:
- The form belonging to the form record.
-
getXFormRenderConfig
@Nullable 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. Whennull
, an appropriate default is used: (true
when theProjekt.isAnonymize()
requires it, orfalse
otherwise.)
-
isUnsafeSkipFormRecordLock
@Deprecated boolean isUnsafeSkipFormRecordLock()
Deprecated.UsegetFormRecordLockContext()
with a dummy context.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 defaultfalse
.- Returns:
true
to skip locking, orfalse
to lock the form record for exclusive use before executing a task.
-
getUser
@Deprecated Benutzer getUser()
Deprecated.UsegetUserModel()
instead.- Returns:
- The user who initiated the workflow.
-
-