flux

Interface AbstractFlowContextStatus

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

FlowChartElement, FlowContextDetails, FlowContextStatus

public interface AbstractFlowContextStatus
extends java.io.Serializable

Represents the state of a running flow context within an executing flow chart. If this state is retrieved from the running flow context itself, it represents the current state of the running flow context. Otherwise, it represents the state of the running flow context from when the last transaction committed.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
int	getEffectivePriority() Returns the effective priority of this flow context.
long	getId() Returns the flow context ID for this flow context.
java.lang.String	getName() Returns the name of the trigger or action that the running flow context is currently executing.
int	getPriority() Returns the priority of this flow context.
SubState	getSubState() Returns the sub-state that the running flow context is currently in.
SuperState	getSuperState() Returns the super-state that the running flow context is currently in, which is either NORMAL or ERROR.

Method Detail

getEffectivePriority

int getEffectivePriority()

Returns the effective priority of this flow context.

It is possible that higher priority flow charts will run so frequently as to prevent lower priority flow charts from running at an acceptable rate. This behavior is called "starvation", that is, lower priority flow charts can be starved or prevented from running as frequently as desired.

If the engine configuration property FAIRNESS_TIME_WINDOW is enabled, a starved flow chart's priority is increased over time to provide it an opportunity to run.

This increased flow chart priority is called the flow context's "effective priority".

Returns:

The effective priority of this flow context.

See Also:

getPriority(), Configuration.FAIRNESS_TIME_WINDOW

getId

long getId()

Returns the flow context ID for this flow context.

Returns:

The flow context ID for this flow context.

getName

java.lang.String getName()

Returns the name of the trigger or action that the running flow context is currently executing.

Returns:

The name of the trigger or action that the running flow context is currently executing.

getPriority

int getPriority()

Returns the priority of this flow context.

Returns:

The priority of this flow context.

See Also:

getEffectivePriority()

getSubState

SubState getSubState()

Returns the sub-state that the running flow context is currently in.

Returns:

The sub-state that the running flow context is currently in.

getSuperState

SuperState getSuperState()

Returns the super-state that the running flow context is currently in, which is either NORMAL or ERROR. Under normal conditions, the super-state is NORMAL. The state, returned by getState(), indicates the sub-state, such as WAITING or FIRING.

Returns:

The super-state that the running flow context is currently in.