Package de.xima.fc.interfaces.workflow.execution

Interface IWorkflowExecutionEnvironmentData

All Superinterfaces:

IBaseEnvironmentData, IBaseWorkflowEnvironmentData

public interface IWorkflowExecutionEnvironmentData
extends IBaseWorkflowEnvironmentData

Data related to the current workflow execution, such as the form record or the locale.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
Clock	getClock()
default Benutzer	getEffectiveUser()	Deprecated. Use getEffectiveUserModel() instead.
default IUser	getEffectiveUserModel()
IFormDataAdapter	getFormDataAdapter()
Vorgang	getFormRecord()
IXForm	getXForm()
IXFormRenderConfig	getXFormRenderConfig()
boolean	isAnonymize()

Methods inherited from interface de.xima.fc.interfaces.workflow.execution.IBaseEnvironmentData

getClient, getEntityContext, getLocale, getUser, getUserModel

Methods inherited from interface de.xima.fc.interfaces.workflow.params.IBaseWorkflowEnvironmentData

getProject, getWorkflowVersion

Method Details

getClock

Clock getClock()

Returns:

The clock to use for obtaining the current time.

Since:

8.0.0

getEffectiveUser

@Deprecated
default Benutzer getEffectiveUser()

Deprecated.

Use getEffectiveUserModel() instead.

Returns:

An anonymous user when isAnonymize() is set to true, or the actual IBaseEnvironmentData.getUser() otherwise.

getEffectiveUserModel

default IUser getEffectiveUserModel()

Returns:

An anonymous user when isAnonymize() is set to true, or the actual IBaseEnvironmentData.getUserModel() otherwise.

getFormDataAdapter

IFormDataAdapter getFormDataAdapter()

Returns:

The IFormDataAdapter for the current form record that can be used to access the current form data. Note that changes to the form data (IFormDataAdapter.getRequestDataMap() are saved automatically when workflow execution finishes and the form record is saved to the database. Use IWorkflowFormHandler.persistFormRecord() if you need to save the changes immediately.

getFormRecord

Vorgang getFormRecord()

Returns:

The current Vorgang for which the workflow is executed.

getXForm

IXForm getXForm()

Returns:

The IXForm for the current form record.

getXFormRenderConfig

IXFormRenderConfig getXFormRenderConfig()

Returns:

The configuration that was used for rendering the form for the current form record.

isAnonymize

boolean isAnonymize()

Returns:

true if data related to individual persons must be anonymized.