Package org.pentaho.platform.api.engine
Interface IActionSequence
-
- All Superinterfaces:
ISequenceDefinition
public interface IActionSequence extends ISequenceDefinition
An ActionSequence is the functional object that wraps a SequenceDefinition for processing by the RuntimeContext. When a request results in a RuntimeContext execution, it is the ActionSequence that the context is operazting on.
-
-
Field Summary
-
Fields inherited from interface org.pentaho.platform.api.engine.ISequenceDefinition
ACTION_SEQUENCE_DEFINITION_INVALID_ACTION_DOC, ACTION_SEQUENCE_DEFINITION_INVALID_XML, ACTION_SEQUENCE_DEFINITION_OK, RESULT_TYPE_NONE, RESULT_TYPE_PROCESS, RESULT_TYPE_REPORT, RESULT_TYPE_RULE
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ListgetActionDefinitionsAndSequences()Returns the list of ActionDefinition objects retrieved from the SequenceDefinition.IConditionalExecutiongetConditionalExecution()StringgetLoopParameter()If the ActionSequence contains a loop, returns the parameter that the execution should loop on.booleangetLoopUsingPeek()If the ActionSequence contains a loop, returns the parameter that the execution should loop on.booleanhasLoop()Returns whether the ActionSequence has a loop in its definition.voidsetConditionalExecution(IConditionalExecution value)Sets the ConditionalExecution object that determines whether a set of actions will be executed.-
Methods inherited from interface org.pentaho.platform.api.engine.ISequenceDefinition
getAuthor, getDescription, getHelp, getIcon, getInputDefinitions, getInputDefinitionsForParameterProvider, getLoggingLevel, getOutputDefinitions, getResourceDefinitions, getResultType, getSequenceName, getSolutionName, getSolutionPath, getTitle
-
-
-
-
Method Detail
-
getActionDefinitionsAndSequences
List getActionDefinitionsAndSequences()
Returns the list of ActionDefinition objects retrieved from the SequenceDefinition.- Returns:
- list of ActionDefinitions
-
getLoopParameter
String getLoopParameter()
If the ActionSequence contains a loop, returns the parameter that the execution should loop on.- Returns:
- the parameter to loop on, if looping is defined, otherwise null
-
getLoopUsingPeek
boolean getLoopUsingPeek()
If the ActionSequence contains a loop, returns the parameter that the execution should loop on.- Returns:
- the parameter to loop on, if looping is defined, otherwise null
-
hasLoop
boolean hasLoop()
Returns whether the ActionSequence has a loop in its definition.- Returns:
- true if looping is defined, otherwise false
-
getConditionalExecution
IConditionalExecution getConditionalExecution()
- Returns:
- The conditional execution object that determines whether a set of actions will be executed.
-
setConditionalExecution
void setConditionalExecution(IConditionalExecution value)
Sets the ConditionalExecution object that determines whether a set of actions will be executed.- Parameters:
value- The ConditionalExecution object
-
-