Package de.xima.fc.workflow.processor.logic.execution

Class TriggerOnTaskBeginParams<TData>

java.lang.Object

de.xima.fc.workflow.processor.logic.execution.TriggerOnTaskBeginParams<TData>

Type Parameters:

TData - Type of the trigger's properties model.

All Implemented Interfaces:

IElementKeyProviding, IWorkflowElementWithDeserializedModel<TData,WorkflowTrigger>, ITriggerOnTaskBeginParams<TData>

public final class TriggerOnTaskBeginParams<TData>
extends Object
implements ITriggerOnTaskBeginParams<TData>

Default implementation of a ITriggerOnTaskBeginParams. 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
TriggerOnTaskBeginParams(IWorkflowExecutionContext workflowContext, IWorkflowEventData eventData, WorkflowTask task, WorkflowTrigger trigger)	Creates a new instance with the given data.

Method Summary

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

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.ITriggerOnTaskBeginParams

getEventDataAs

Constructor Detail

TriggerOnTaskBeginParams

public TriggerOnTaskBeginParams(IWorkflowExecutionContext workflowContext,
                                IWorkflowEventData eventData,
                                WorkflowTask task,
                                WorkflowTrigger trigger)

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, returned by getElement().

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 ITriggerOnTaskBeginParams<TData>

Returns:

The event data describing the event that occurred.

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 ITriggerOnTaskBeginParams<TData>

Returns:

The task that is about to be executed.

getWorkflowContext

public IWorkflowExecutionContext getWorkflowContext()

Specified by:

getWorkflowContext in interface ITriggerOnTaskBeginParams<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.

result

public IOnTaskBeginRetValBuilder result()

Specified by:

result in interface ITriggerOnTaskBeginParams<TData>

Returns:

A builder for creating the result.