Package com.orchestranetworks.interactions

# Class InteractionHelper.ParametersMap

java.lang.Object
com.orchestranetworks.interactions.InteractionHelper.ParametersMap

Enclosing class:
  InteractionHelper

public static final class InteractionHelper.ParametersMap extends Object
Defines the parameters of an interaction, either the input, output or internal parameters.

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `ParametersMap()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `Iterator<String>`
  `getVariableNames()`
  Returns the names of the interaction parameters.
  `String`
  `getVariableString(String aVariableName)`
  Returns the value of the parameter with the specified name, `null` if the parameter is unset.
  `Object`
  `setVariableString(String aVariableName, String aValue)`
  Updates a parameter value.

  ### Methods inherited from class java.lang.Object

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

- ## Constructor Details

  - ### ParametersMap

    public ParametersMap()

- ## Method Details

  - ### getVariableString

    public String getVariableString(String aVariableName)
    Returns the value of the parameter with the specified name, `null` if the parameter is unset.

  - ### getVariableNames

    public Iterator<String> getVariableNames()
    Returns the names of the interaction parameters.

  - ### setVariableString

    public Object setVariableString(String aVariableName, String aValue)
    Updates a parameter value.

    This method only sets the value in the local context. To save the change in the interaction, invoke a method to set the parameters map in the interaction.

    See Also:
      - `SessionInteraction.setInternalParameters(com.orchestranetworks.interactions.InteractionHelper.ParametersMap)`
      - `SessionInteraction.complete(com.orchestranetworks.interactions.InteractionHelper.ParametersMap)`