flux
Interface Flow

All Superinterfaces:

RuntimeDataMap, java.io.Serializable

public interface Flow
extends RuntimeDataMap, java.io.Serializable

Represents a flow from one action or trigger to another.

A flow may also have a set of signals to raise if it is followed. A signal is a String. The signal will stay raised until a flow is followed that clears the signal. Signals are only visible to the flow chart that raised the signal.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

See Also:

Action.setSignalsToMonitor(java.util.Set)

Method Summary

Condition	getCondition() Returns the condition for this flow, if any.
java.util.Set<java.lang.String>	getSignalsToClear() Returns the signals that this flow will clear if it is followed.
java.util.Set<java.lang.String>	getSignalsToRaise() Returns the signals that this flow will raise if it is followed.
Action	getSourceAction() Returns the action at the beginning of this flow.
Action	getTargetAction() Returns the action at the end of this flow.
void	setCondition(java.lang.String condition) Sets the condition for this flow, if any.
void	setSignalsToClear(java.util.Set<java.lang.String> signals) Sets the signals that this flow will clear if it is followed.
void	setSignalsToRaise(java.util.Set<java.lang.String> signals) Sets the signals that this flow will raise if it is followed.

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

getCondition

Condition getCondition()

Returns the condition for this flow, if any.

Returns:

The condition for this flow, possibly null.

getSignalsToClear

java.util.Set<java.lang.String> getSignalsToClear()

Returns the signals that this flow will clear if it is followed.

Returns:

The signals that this flow will clear if it is followed. A signal is a non-null, non-empty string.

getSignalsToRaise

java.util.Set<java.lang.String> getSignalsToRaise()

Returns the signals that this flow will raise if it is followed.

Returns:

The signals that this flow will raise if it is followed. A signal is a non-null, non-empty string.

getSourceAction

Action getSourceAction()

Returns the action at the beginning of this flow.

Returns:

The action at the beginning of this flow.

getTargetAction

Action getTargetAction()

Returns the action at the end of this flow.

Returns:

The action at the end of this flow.

setCondition

void setCondition(java.lang.String condition)

Sets the condition for this flow, if any.

Parameters:

condition - The condition for this flow, possibly null.

setSignalsToClear

void setSignalsToClear(java.util.Set<java.lang.String> signals)

Sets the signals that this flow will clear if it is followed.

Parameters:

signals - The signals that this flow will clear. A signal is a non-null, non-empty string.

Throws:

java.lang.IllegalArgumentException - If signals is null, if signals contains a null value, or if signals contains the empty string.

setSignalsToRaise

void setSignalsToRaise(java.util.Set<java.lang.String> signals)

Sets the signals that this flow will raise if it is followed.

Parameters:

signals - The signals that this flow will raise. A signal is a non-null, non-empty string.

Throws:

java.lang.IllegalArgumentException - If signals is null, if signals contains a null value, or if signals contains the empty string.