org.pentaho.platform.engine.services.runtime
Class ParameterManager

java.lang.Object
  org.pentaho.platform.engine.services.runtime.ParameterManager

All Implemented Interfaces:

IParameterManager

public class ParameterManager
extends Object
implements IParameterManager

Nested Class Summary

class

ParameterManager.ReturnParameter

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 resourceName)
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)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAllParameters

public Map getAllParameters()

Specified by:

getAllParameters in interface IParameterManager

getCurrentInput

public IActionParameter getCurrentInput(String inputName)

Specified by:

getCurrentInput in interface IParameterManager

getCurrentOutput

public IActionParameter getCurrentOutput(String outputName)

Specified by:

getCurrentOutput in interface IParameterManager

getCurrentResource

public IActionSequenceResource getCurrentResource(String resourceName)

Specified by:

getCurrentResource in interface IParameterManager

getCurrentInputNames

public Set getCurrentInputNames()

Specified by:

getCurrentInputNames in interface IParameterManager

getLoopParameter

public IActionParameter getLoopParameter(String inputName)

Specified by:

getLoopParameter in interface IParameterManager

getCurrentOutputNames

public Set getCurrentOutputNames()

Specified by:

getCurrentOutputNames in interface IParameterManager

getCurrentResourceNames

public Set getCurrentResourceNames()

Specified by:

getCurrentResourceNames in interface IParameterManager

dispose

public void dispose()

Specified by:

dispose in interface IParameterManager

dispose

public void dispose(List exceptParameters)

Specified by:

dispose in interface IParameterManager

resetParameters

public void resetParameters()

Specified by:

resetParameters in interface IParameterManager

setCurrentParameters

public void setCurrentParameters(ISolutionActionDefinition actionDefinition)

Specified by:

setCurrentParameters in interface IParameterManager

addToAllInputs

public void addToAllInputs(String key,
                           IActionParameter param)

Specified by:

addToAllInputs in interface IParameterManager

addToCurrentInputs

public void addToCurrentInputs(String key,
                               IActionParameter param)

Specified by:

addToCurrentInputs in interface IParameterManager

addOutputParameters

public boolean addOutputParameters(ISolutionActionDefinition actionDefinition)

Specified by:

addOutputParameters in interface IParameterManager

getReturnParameters

public Map getReturnParameters()

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

Specified by:

getReturnParameters in interface IParameterManager

Parameters:

actionSequence - The Action Sequence definition to use

Returns:

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

getActualRequestParameterName

public String getActualRequestParameterName(String fieldName)

Specified by:

getActualRequestParameterName in interface IParameterManager

getInput

public IActionParameter getInput(String inputName)

Specified by:

getInput in interface IParameterManager