org.pentaho.platform.api.engine
Interface IParameterManager

All Known Implementing Classes:

ParameterManager

public interface IParameterManager

Method Summary

boolean	addOutputParameters(ISolutionActionDefinition actionDefinition)
void	addToAllInputs(String key, IActionParameter param)
void	addToCurrentInputs(String key, IActionParameter param)
void	dispose()
void	dispose(List exceptParameters)
String	getActualRequestParameterName(String fieldName)
Map	getAllParameters()
IActionParameter	getCurrentInput(String inputName)
Set	getCurrentInputNames()
IActionParameter	getCurrentOutput(String outputName)
Set	getCurrentOutputNames()
IActionSequenceResource	getCurrentResource(String resource)
Set	getCurrentResourceNames()
IActionParameter	getInput(String inputName)
IActionParameter	getLoopParameter(String inputName)
Map	getReturnParameters() Returns a mapping of output parameters and the value and destination.
void	resetParameters()
void	setCurrentParameters(ISolutionActionDefinition actionDefinition)

Method Detail

getAllParameters

Map getAllParameters()

getCurrentInput

IActionParameter getCurrentInput(String inputName)

getCurrentOutput

IActionParameter getCurrentOutput(String outputName)

getCurrentResource

IActionSequenceResource getCurrentResource(String resource)

getCurrentInputNames

Set getCurrentInputNames()

getLoopParameter

IActionParameter getLoopParameter(String inputName)

getActualRequestParameterName

String getActualRequestParameterName(String fieldName)

getCurrentOutputNames

Set getCurrentOutputNames()

getCurrentResourceNames

Set getCurrentResourceNames()

dispose

void dispose()

dispose

void dispose(List exceptParameters)

resetParameters

void resetParameters()

setCurrentParameters

void setCurrentParameters(ISolutionActionDefinition actionDefinition)

addToAllInputs

void addToAllInputs(String key,
                    IActionParameter param)

addToCurrentInputs

void addToCurrentInputs(String key,
                        IActionParameter param)

addOutputParameters

boolean addOutputParameters(ISolutionActionDefinition actionDefinition)

getReturnParameters

Map getReturnParameters()

Returns a mapping of output parameters and the value and destination.

Parameters:

actionSequence - The Action Sequence definition to use

Returns:

a map with the param name as the key and a ReturnParameter containing the data.

getInput

IActionParameter getInput(String inputName)