Class ParameterManager

  • All Implemented Interfaces:
    org.pentaho.platform.api.engine.IParameterManager

    public class ParameterManager
    extends Object
    implements org.pentaho.platform.api.engine.IParameterManager
    • Method Detail

      • getAllParameters

        public Map getAllParameters()
        Specified by:
        getAllParameters in interface org.pentaho.platform.api.engine.IParameterManager
      • getCurrentInput

        public org.pentaho.platform.api.engine.IActionParameter getCurrentInput​(String inputName)
        Specified by:
        getCurrentInput in interface org.pentaho.platform.api.engine.IParameterManager
      • getCurrentOutput

        public org.pentaho.platform.api.engine.IActionParameter getCurrentOutput​(String outputName)
        Specified by:
        getCurrentOutput in interface org.pentaho.platform.api.engine.IParameterManager
      • getCurrentResource

        public org.pentaho.platform.api.engine.IActionSequenceResource getCurrentResource​(String resourceName)
        Specified by:
        getCurrentResource in interface org.pentaho.platform.api.engine.IParameterManager
      • getCurrentInputNames

        public Set getCurrentInputNames()
        Specified by:
        getCurrentInputNames in interface org.pentaho.platform.api.engine.IParameterManager
      • getLoopParameter

        public org.pentaho.platform.api.engine.IActionParameter getLoopParameter​(String inputName)
        Specified by:
        getLoopParameter in interface org.pentaho.platform.api.engine.IParameterManager
      • getCurrentOutputNames

        public Set getCurrentOutputNames()
        Specified by:
        getCurrentOutputNames in interface org.pentaho.platform.api.engine.IParameterManager
      • getCurrentResourceNames

        public Set getCurrentResourceNames()
        Specified by:
        getCurrentResourceNames in interface org.pentaho.platform.api.engine.IParameterManager
      • disposeParameter

        protected boolean disposeParameter​(ActionParameter param)
      • dispose

        public void dispose()
        Specified by:
        dispose in interface org.pentaho.platform.api.engine.IParameterManager
      • dispose

        public void dispose​(List exceptParameters)
        Specified by:
        dispose in interface org.pentaho.platform.api.engine.IParameterManager
      • resetParameters

        public void resetParameters()
        Specified by:
        resetParameters in interface org.pentaho.platform.api.engine.IParameterManager
      • setCurrentParameters

        public void setCurrentParameters​(org.pentaho.platform.api.engine.ISolutionActionDefinition actionDefinition)
        Specified by:
        setCurrentParameters in interface org.pentaho.platform.api.engine.IParameterManager
      • addToAllInputs

        public void addToAllInputs​(String key,
                                   org.pentaho.platform.api.engine.IActionParameter param)
        Specified by:
        addToAllInputs in interface org.pentaho.platform.api.engine.IParameterManager
      • addToCurrentInputs

        public void addToCurrentInputs​(String key,
                                       org.pentaho.platform.api.engine.IActionParameter param)
        Specified by:
        addToCurrentInputs in interface org.pentaho.platform.api.engine.IParameterManager
      • addOutputParameters

        public boolean addOutputParameters​(org.pentaho.platform.api.engine.ISolutionActionDefinition actionDefinition)
        Specified by:
        addOutputParameters in interface org.pentaho.platform.api.engine.IParameterManager
      • getReturnParameters

        public Map getReturnParameters()
        Returns a mapping of output parameters and the value and destination.
        Specified by:
        getReturnParameters in interface org.pentaho.platform.api.engine.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 org.pentaho.platform.api.engine.IParameterManager
      • getInput

        public org.pentaho.platform.api.engine.IActionParameter getInput​(String inputName)
        Specified by:
        getInput in interface org.pentaho.platform.api.engine.IParameterManager