flux
Interface ForEachAction

All Superinterfaces:

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

All Known Subinterfaces:

ForEachCollectionElementAction, ForEachNumberAction

public interface ForEachAction
extends Action

Abstract interface used by "for each" actions, which iterate over a collection of data. The actual data returned by the for each action is returned in the flow context using the name specified by the loop index. An indication of whether the end-of-data has been found is returned to the flow context as an object of type For_Each_Res.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Nested Class Summary

static class	ForEachAction.For_Each_Res Deprecated. Use ForEachResult instead. Deprecated in Flux 7.2. Will be removed in Flux 8.0.
static class	ForEachAction.ForEachResult The result from a "for each" action, which indicates whether the end of data has been found.

Method Summary

java.lang.String	getLoopIndex() Returns the flow context variable that contains one of the data that is being iterated over.
void	setExpirationFlow(Action action) Sets the flow to follow after this for each action is finished.
void	setLoopIndex(java.lang.String loopIndex) Sets the flow context variable that contains one of the data that is being iterated over.

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

getLoopIndex

java.lang.String getLoopIndex()

Returns the flow context variable that contains one of the data that is being iterated over.

Defaults to "i".

Returns:

The flow context variable that contains one of the data that is being iterated over.

setExpirationFlow

void setExpirationFlow(Action action)

Sets the flow to follow after this for each action is finished. Delegates to setElseFlow().

Parameters:

action - The action that executes next after this for each action is finished.

setLoopIndex

void setLoopIndex(java.lang.String loopIndex)

Sets the flow context variable that contains one of the data that is being iterated over. Concrete "for each" actions return variables in the flow context that contain actual result data.

Defaults to "i".

Parameters:

loopIndex - The flow context variable that contains one of the data that is being iterated over.