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

Class PreconditionSatisfiedParams<TData>

java.lang.Object

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

Type Parameters:

TData - Type of the trigger's properties model.

All Implemented Interfaces:

ITriggerPreconditionSatisfiedParams<TData>, IElementKeyProviding, IWorkflowElementWithDeserializedModel<TData,WorkflowTrigger>

public final class PreconditionSatisfiedParams<TData>
extends Object
implements ITriggerPreconditionSatisfiedParams<TData>

Default implementation of a ITriggerPreconditionSatisfiedParams. Allows for the properties model to be retrieved lazily when needed.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
PreconditionSatisfiedParams(WorkflowTrigger trigger, IWorkflowEventData eventData, IWorkflowExecutionEnvironmentData environmentData)	Creates a new params instance.

Method Summary

Modifier and Type	Method	Description
TData	getData()
WorkflowTrigger	getElement()
IWorkflowExecutionEnvironmentData	getEnvironmentData()
IWorkflowEventData	getEventData()
ElementKey	getKey()

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.event.ITriggerPreconditionSatisfiedParams

getEventDataAs

Constructor Details

PreconditionSatisfiedParams

public PreconditionSatisfiedParams(WorkflowTrigger trigger,
 IWorkflowEventData eventData,
 IWorkflowExecutionEnvironmentData environmentData)

Creates a new params instance. The properties model of the trigger is deserialized lazily when needed.

Parameters:

trigger - Trigger for which to check the precondition.

eventData - Event data of the event that occurred.

environmentData - Current environment data with the form record, client etc.

Method Details

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.

getEnvironmentData

public IWorkflowExecutionEnvironmentData getEnvironmentData()

Specified by:

getEnvironmentData in interface ITriggerPreconditionSatisfiedParams<TData>

Returns:

Environment data with the form record, entity context etc.

getEventData

public IWorkflowEventData getEventData()

Specified by:

getEventData in interface ITriggerPreconditionSatisfiedParams<TData>

Returns:

The event data describing the event that occurred. The trigger should check whether the trigger still applies to this event.

getKey

public ElementKey getKey()

Specified by:

getKey in interface IElementKeyProviding

Returns:

The key that identifies this instance.