flux
Interface FlowChartTrigger

All Superinterfaces:

Action, java.lang.Cloneable, RuntimeDataMap, java.io.Serializable, Trigger

public interface FlowChartTrigger
extends Trigger

Watches a given namespace until there are no more flow charts in that namespace.

In its simplest form, the Flow Chart Trigger simply waits for another flow chart to finish before firing. For example, if flow chart /thisFlowChart needs to wait for /otherFlowChart to finish before /thisFlowChart can continue, a Flow Chart Trigger can be configured to meet that need.

In its full form, the Flow Chart Trigger can be configured to wait for an entire namespace of flow charts to finish before firing.

It is illegal to set a namespace of "/", since it implies there are no flow charts in the entire cluster. Of course, if this flow chart trigger is active, its flow chart is in the cluster and this trigger could never fire.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.String	getNamespace() Returns the namespace of flow charts to watch.
void	setNamespace(java.lang.String namespace) Sets the namespace of flow charts to watch.

Methods inherited from interface flux.Action

addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

getNamespace

java.lang.String getNamespace()

Returns the namespace of flow charts to watch. When there are no more flow charts in the specified namespace, this trigger fires.

Returns:

The namespace of flow charts to watch.

setNamespace

void setNamespace(java.lang.String namespace)
                  throws java.lang.IllegalArgumentException

Sets the namespace of flow charts to watch. When there are no more flow charts in the specified namespace, this trigger fires.

It is illegal to set a namespace of "/", since it implies there are no flow charts in the entire cluster. Of course, if this flow chart trigger is active, its flow chart is in the cluster and this trigger could never fire.

Parameters:

namespace - A properly formed namespace expression. Cannot be "/". Can be null.

Throws:

java.lang.IllegalArgumentException - If namespace is "/", the empty string, or an otherwise illegal namespace expression.