flux
Interface FlowContextStatus

All Superinterfaces:

AbstractFlowContextStatus, java.io.Serializable

All Known Subinterfaces:

FlowChartElement

public interface FlowContextStatus
extends AbstractFlowContextStatus

Represents the state of a running flow context within an executing flow chart.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

ErrorResultElement

getFailureErrorResult() If this flow context status is in the ERROR super-state and the FAILED sub-state, returns the error result that describes how this flow context entered this state.

Methods inherited from interface flux.AbstractFlowContextStatus

getEffectivePriority, getId, getName, getPriority, getSubState, getSuperState

Method Detail

getFailureErrorResult

ErrorResultElement getFailureErrorResult()

If this flow context status is in the ERROR super-state and the FAILED sub-state, returns the error result that describes how this flow context entered this state.

By definition, whenever a flow context is executing a default flow chart error handler, that flow context is in the ERROR super-state. Also by definition, if a default flow chart error handler throws an exception, that flow context is deemed to have failed and placed into the FAILED sub-state.

Flow contexsts in the FAILED sub-state do not execute. They must be recovered explicitly in order for them to continue executing. The Engine.recover() method is used to recover failed flow contexts.

If this flow context status is not in the ERROR super-state, this method returns null.

Returns:

If this flow context status is in the ERROR super-state, returns the error result that describes how this flow context entered this state. Otherwise, returns null.

See Also:

SuperState.ERROR, Engine.recover(java.lang.String)