Package de.xima.fc.interfaces.workflow.params

Interface ICreateFlowGraphParams<TData,TElement extends IWorkflowNodeTypeProviding>

Type Parameters:

TData - Type of the properties model for the node. See INodeHandler.

TElement - Type of the processed node.

public interface ICreateFlowGraphParams<TData,TElement extends IWorkflowNodeTypeProviding>

Interface for the parameters that are passed to createFlowGraph of IWorkflowNodeFlowAnalyzer.

Since:

7.0.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
ICreateFlowGraphContext<TElement>	getAnalysisContext()	Returns the context of the current analysis of potentially executed nodes.
List<TElement>	getChildren()
NodeKey	getKey()
TElement	getNode()
IFlowGraphEdgeDataConfigurator	normalEdge()	A configurator for marking an edge as a normal forward edge.
IFlowGraphEdgeDataConfigurator	throwingEdge()	Retrieves a configurator for marking an edge as a throwing forward edge.

Method Detail

getAnalysisContext

ICreateFlowGraphContext<TElement> getAnalysisContext()

Returns the context of the current analysis of potentially executed nodes. How children of a node are analyzed depends on the node kind - use ICreateFlowGraphContext.createFlowGraph(IWorkflowNodeTypeProviding) (or one of its variants) to start the analysis of child nodes.

Returns:

The context of the current execution analysis.

getChildren

List<TElement> getChildren()

Returns:

The children of the workflow node.

getKey

NodeKey getKey()

Returns:

The key of the workflow node.

getNode

TElement getNode()

Returns:

The node that needs to be analyzed. The exact type of this element may be different depending on whether the execution analysis is run on the backend data model (WorkflowNode) or the corresponding frontend view model.

normalEdge

IFlowGraphEdgeDataConfigurator normalEdge()

A configurator for marking an edge as a normal forward edge. Intended for use with various connect methods from ICreateFlowGraphContext.

Intended as an argument to be passed to the various connect methods from ICreateFlowGraphContext. You should NOT reuse the return value of this method, call it once for each call to connect, e.g.:

 ctx.connect(from, to, params.normalEdge())}
 

Returns:

A configurator for connecting nodes with normal edges.

Since:

8.0.0

throwingEdge

IFlowGraphEdgeDataConfigurator throwingEdge()

Retrieves a configurator for marking an edge as a throwing forward edge.

Intended as an argument to be passed to the various connect methods from ICreateFlowGraphContext. You should NOT reuse the return value of this method, call it once for each call to connect, e.g.: *

 ctx.connect(from, to, params.throwingEdge())
 

Returns:

A configurator for connecting nodes with throwing edges.

Since:

8.0.0