Package com.artisol.teneo.engine.core.engine

Interface EngineAccess.Data.ActiveFlow

All Superinterfaces:

EngineAccess.Data.Flow

Enclosing interface:

EngineAccess.Data

public static interface EngineAccess.Data.ActiveFlow
extends EngineAccess.Data.Flow

The data of an active flow stack entry.

Since:

1.3.0

Method Summary

Modifier and Type	Method	Description
void	abort()	Marks this flow for premature termination.
String	getDescription()	Returns the description text of this flow.
EngineAccess.Data.FlowTrigger	getFlowTrigger()	Returns the trigger which caused this active flow to be raised.
String	getFolderPath()	Returns the path of the solution folder this flow is stored in.
String	getId()	Returns the ID of this flow.
String	getInstanceId()	Returns the instance ID of this active flow (it distinguishes multiple active instances of the flow with the ID returned by method getId()).
Map<String,String>	getMetadata()	Returns the metadata of this flow, including any default values.
String	getName()	Returns the name of this flow.
String	getType()	Returns the type of this flow.
Bindings	getVariables()	Returns the variables of this active flow (without session variables).
EngineAccess.Data.Vertex	getVertex()	In case this object was returned by methods EngineAccess.getActiveFlows(), EngineAccess.getTopFlow(), EngineAccess.getTopNormalFlow() the flow vertex last processed (a direct pre-vertex of the vertex currently being processed) is returned. In case this object was returned by method EngineAccess.getThisFlow() the vertex currently being processed is returned.
boolean	isAborted()	States whether this flow is marked for immediate termination when it is/becomes the top flow.
String	toString()	Returns a human readable representation of this flow.

Method Detail

getId

String getId()

Description copied from interface: EngineAccess.Data.Flow

Returns the ID of this flow.

Specified by:

getId in interface EngineAccess.Data.Flow

getName

String getName()

Description copied from interface: EngineAccess.Data.Flow

Returns the name of this flow.

Specified by:

getName in interface EngineAccess.Data.Flow

getType

String getType()

Description copied from interface: EngineAccess.Data.Flow

Returns the type of this flow. The value is either "normal" for a normal flow, or "sub" for a subflow (invoked on behalf of a normal flow).

Specified by:

getType in interface EngineAccess.Data.Flow

getDescription

String getDescription()

Description copied from interface: EngineAccess.Data.Flow

Returns the description text of this flow.

Specified by:

getDescription in interface EngineAccess.Data.Flow

getFolderPath

String getFolderPath()

Description copied from interface: EngineAccess.Data.Flow

Returns the path of the solution folder this flow is stored in.

Specified by:

getFolderPath in interface EngineAccess.Data.Flow

getMetadata

Map<String,String> getMetadata()

Description copied from interface: EngineAccess.Data.Flow

Returns the metadata of this flow, including any default values.

Specified by:

getMetadata in interface EngineAccess.Data.Flow

Returns:

an unmodifiable Map containing the metadata name/value pairs

getFlowTrigger

EngineAccess.Data.FlowTrigger getFlowTrigger()

Returns the trigger which caused this active flow to be raised.

Returns:

a FlowTriggerEx if this flow is a normal flow, otherwise null (that is, if this flow is a routed flow or a subflow)

Since:

1.3.0

getInstanceId

String getInstanceId()

Returns the instance ID of this active flow (it distinguishes multiple active instances of the flow with the ID returned by method getId()).

Since:

1.3.0

getVariables

Bindings getVariables()

Returns the variables of this active flow (without session variables).

Returns:

a non-resizable binding (that is, adding/deleting variables is not supported)

Since:

1.3.0

getVertex

EngineAccess.Data.Vertex getVertex()

• In case this object was returned by methods EngineAccess.getActiveFlows(), EngineAccess.getTopFlow(), EngineAccess.getTopNormalFlow() the flow vertex last processed (a direct pre-vertex of the vertex currently being processed) is returned.
• In case this object was returned by method EngineAccess.getThisFlow() the vertex currently being processed is returned.

Returns:

a EngineAccess.Data.Vertex, or null if vertex processing yet didn't start for this flow

Since:

1.3.0

abort

void abort()

Marks this flow for premature termination. See EngineAccess.abortActiveFlow(String) for more details.

An invocation of this method yields exactly the same result as the expression

EngineAccess.abortActiveFlow(<this flow>.getInstanceId())

Since:

3.0.0

See Also:

EngineAccess.abortActiveFlow(String), isAborted()

isAborted

boolean isAborted()

States whether this flow is marked for immediate termination when it is/becomes the top flow.

Since:

3.0.0

See Also:

abort()

toString

String toString()

Description copied from interface: EngineAccess.Data.Flow

Returns a human readable representation of this flow.

Specified by:

toString in interface EngineAccess.Data.Flow

Overrides:

toString in class Object