Package de.xima.fc.workflow.processor.model

Class TriggerOnTaskFinishParams<TData>

java.lang.Object

de.xima.fc.workflow.processor.model.TriggerOnTaskFinishParams<TData>

Type Parameters:

TData - Type of the trigger's properties model.

All Implemented Interfaces:

IElementKeyProviding, IWorkflowElementWithDeserializedModel<TData,WorkflowTrigger>, ITriggerOnTaskFinishParams<TData>

public final class TriggerOnTaskFinishParams<TData>
extends Object
implements ITriggerOnTaskFinishParams<TData>

Default implementation of a ITriggerOnTaskFinishParams. Allows for the trigger's properties model to be retrieved lazily when needed.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
TriggerOnTaskFinishParams(IWorkflowExecutionContext workflowContext, IWorkflowEventData eventData, WorkflowTask task, WorkflowTrigger trigger, ITaskExecutionResult executionResult)	Creates a new instance with the given data.

Method Summary

Modifier and Type	Method	Description
TData	getData()
WorkflowTrigger	getElement()
IWorkflowEventData	getEventData()
ITaskExecutionResult	getExecutionResult()
ElementKey	getKey()
WorkflowTask	getTask()
IWorkflowExecutionContext	getWorkflowContext()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getEventDataAs, isWasSuccessful

Constructor Detail

TriggerOnTaskFinishParams

public TriggerOnTaskFinishParams(IWorkflowExecutionContext workflowContext,
                                 IWorkflowEventData eventData,
                                 WorkflowTask task,
                                 WorkflowTrigger trigger,
                                 ITaskExecutionResult executionResult)

Creates a new instance with the given data. The trigger's properties model is deserialized lazily when needed.

Parameters:

workflowContext - Current workflow context of the active execution.

eventData - Event data of the event that started the task, returned by getEventData().

task - Task that is about to start, returned by getTask().

trigger - Trigger that reacted to the event.

executionResult - Result of the executed task, returned by getExecutionResult()

Method Detail

getData

public TData getData()

Specified by:

getData in interface IWorkflowElementWithDeserializedModel<TData,WorkflowTrigger>

Returns:

The custom data of the workflow element. This is passed for convenience, it the the same as ICustomParametersProviding.getCustomParameters(), but already deserialized and updated.

getElement

public WorkflowTrigger getElement()

Specified by:

getElement in interface IWorkflowElementWithDeserializedModel<TData,WorkflowTrigger>

Returns:

The workflow element, i.e. a node or trigger.

getEventData

public IWorkflowEventData getEventData()

Specified by:

getEventData in interface ITriggerOnTaskFinishParams<TData>

Returns:

The event data describing the event that occurred.

getExecutionResult

public ITaskExecutionResult getExecutionResult()

Specified by:

getExecutionResult in interface ITriggerOnTaskFinishParams<TData>

Returns:

The result of the task that was executed. Use ITaskExecutionResult.isWasSuccessful() to check whether the task was completed successfully.

getKey

public ElementKey getKey()

Specified by:

getKey in interface IElementKeyProviding

Returns:

The key that identifies this instance.

getTask

public WorkflowTask getTask()

Specified by:

getTask in interface ITriggerOnTaskFinishParams<TData>

Returns:

The task that was executed.

getWorkflowContext

public IWorkflowExecutionContext getWorkflowContext()

Specified by:

getWorkflowContext in interface ITriggerOnTaskFinishParams<TData>

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.