Interface ITriggerOnTaskFinishParams<TData>
-
- Type Parameters:
TData
- Type of the trigger's properties model.
- All Superinterfaces:
IElementKeyProviding
,IWorkflowElementWithDeserializedModel<TData,WorkflowTrigger>
- All Known Implementing Classes:
TriggerOnTaskFinishParams
public interface ITriggerOnTaskFinishParams<TData> extends IWorkflowElementWithDeserializedModel<TData,WorkflowTrigger>
Parameters passed to the callback methodITriggerHandler.onTaskFinish(ITriggerOnTaskFinishParams)
.- 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>
TgetEventDataAs(Class<T> type)
ITaskExecutionResult
getExecutionResult()
WorkflowTask
getTask()
IWorkflowExecutionContext
getWorkflowContext()
default boolean
isWasSuccessful()
-
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.
-
getExecutionResult
ITaskExecutionResult getExecutionResult()
- Returns:
- The result of the task that was executed. Use
ITaskExecutionResult.isWasSuccessful()
to check whether the task was completed successfully.
-
getTask
WorkflowTask getTask()
- Returns:
- The task that was 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.
-
isWasSuccessful
default boolean isWasSuccessful()
- Returns:
- Whether the task was executed successfully.
-
-