ITriggerOnTaskBeginParams (FORMCYCLE: BOM 7.0.5 API)

Type Parameters:

TData - Type of the trigger's properties model.

All Superinterfaces:

IElementKeyProviding, IWorkflowElementWithDeserializedModel<TData,WorkflowTrigger>

All Known Implementing Classes:

TriggerOnTaskBeginParams
```
public interface ITriggerOnTaskBeginParams<TData>
extends IWorkflowElementWithDeserializedModel<TData,WorkflowTrigger>
```
Parameters passed to the callback method ITriggerHandler.onTaskBegin(ITriggerOnTaskBeginParams).

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`IWorkflowEventData`	`getEventData()`
`default <T extends IWorkflowEventData> T`	`getEventDataAs(Class<T> type)`
`WorkflowTask`	`getTask()`
`IWorkflowExecutionContext`	`getWorkflowContext()`
`IOnTaskBeginRetValBuilder`	`result()`

Methods inherited from interface de.xima.fc.interfaces.workflow.IElementKeyProviding
getKey

Methods inherited from interface de.xima.fc.interfaces.workflow.IWorkflowElementWithDeserializedModel
getData, getElement

- Method Detail
  - getEventData
```
IWorkflowEventData getEventData()
```
    Returns:
    
    The event data describing the event that occurred.
  - getEventDataAs
```
default <T extends IWorkflowEventData> T getEventDataAs(Class<T> type)
```
    Type Parameters:
    
    T - Desired type of the event data.
    
    Parameters:
    
    type - Desired type of the event data.
    
    Returns:
    
    The event data, cast to the given type, or null when the event data is not of the given type.
  - result
```
IOnTaskBeginRetValBuilder result()
```
    Returns:
    
    A builder for creating the result.
  - getTask
```
WorkflowTask getTask()
```
    Returns:
    
    The task that is about to be executed.
  - getWorkflowContext
```
IWorkflowExecutionContext getWorkflowContext()
```
    Returns:
    
    The workflow context of the current workflow execution. Use this context to access various system related features, such as accessing or modifying variables, replacing placeholders, retrieving / writing files, or sending HTTP responses.