flux
Interface ForEachNumberAction

All Superinterfaces:

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

public interface ForEachNumberAction
extends ForEachAction

Iterates over an inclusive range of numbers. The numbers can be integers or floating point numbers. The range can progress in a positive or negative direction. Each number in sequence is returned to the flow context.

The For Each Number Action returns its result in the same format as the For Each Collection Element Action. For more information on accessing and using the result, see ForEachCollectionElementAction.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Nested Class Summary

Nested classes/interfaces inherited from interface flux.ForEachAction

ForEachAction.For_Each_Res, ForEachAction.ForEachResult

Method Summary

double	getEndOfRange() Returns the end of the range of numbers.
double	getStartOfRange() Returns the start of the range of numbers.
double	getStepping() Returns the distance between successive numbers in the range.
void	setEndOfRange(double end) Sets the end of the range of numbers.
void	setEndOfRange(long end) Sets the end of the range of numbers.
void	setExpirationFlow(Action action) Sets the flow to follow after this for each number action expires.
void	setStartOfRange(double start) Sets the start of the range of numbers.
void	setStartOfRange(long start) Sets the start of the range of numbers.
void	setStepping(double stepping) Sets the distance between successive numbers in the range.
void	setStepping(long stepping) Sets the distance between successive numbers in the range.

Methods inherited from interface flux.ForEachAction

getLoopIndex, setLoopIndex

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

getEndOfRange

double getEndOfRange()

Returns the end of the range of numbers. The end of the range may be a number that is lower than the start of the range, which indicates that the sequence progresses from higher numbers to lower numbers.

Returns:

The end of the range.

getStartOfRange

double getStartOfRange()
                       throws EngineException

Returns the start of the range of numbers. The start of the range may be a number that is higher than the end of the range, which indicates that the sequence progresses from higher numbers to lower numbers.

Returns:

The start of the range.

Throws:

EngineException - If a system error occurs.

getStepping

double getStepping()

Returns the distance between successive numbers in the range.

Returns:

The distance between successive numbers in the range.

setEndOfRange

void setEndOfRange(double end)

Sets the end of the range of numbers. The end of the range may be a number that is lower than the start of the range, which indicates that the sequence progresses from higher numbers to lower numbers.

Parameters:

end - The end of the range.

setEndOfRange

void setEndOfRange(long end)

Sets the end of the range of numbers. The end of the range may be a number that is lower than the start of the range, which indicates that the sequence progresses from higher numbers to lower numbers.

Parameters:

end - The end of the range.

setExpirationFlow

void setExpirationFlow(Action action)

Sets the flow to follow after this for each number action expires. This action expires when the number range has been exhaused. Delegates to setElseFlow().

Specified by:

setExpirationFlow in interface ForEachAction

Parameters:

action - The action that executes next after this for each number action expires.

setStartOfRange

void setStartOfRange(double start)

Sets the start of the range of numbers. The start of the range may be a number that is higher than the end of the range, which indicates that the sequence progresses from higher numbers to lower numbers.

Parameters:

start - The start of the range.

setStartOfRange

void setStartOfRange(long start)

Sets the start of the range of numbers. The start of the range may be a number that is higher than the end of the range, which indicates that the sequence progresses from higher numbers to lower numbers.

Parameters:

start - The start of the range.

setStepping

void setStepping(double stepping)

Sets the distance between successive numbers in the range.

Parameters:

stepping - The distance between successive numbers in the range.

Throws:

java.lang.IllegalArgumentException - If stepping is less than 0.

setStepping

void setStepping(long stepping)
                 throws EngineException

Sets the distance between successive numbers in the range.

Parameters:

stepping - The distance between successive numbers in the range.

Throws:

java.lang.IllegalArgumentException - If stepping is less than 0.

EngineException - If a system error occurs.