com.rational.test.ft.script

Interface IVariablesManager

public interface IVariablesManager

The IVariablesManager interface allows access to the input parameters and the output variables from a script. The script will be able to retrieve the input parameters as well as set the output variables.

Since:

8.2.1

Method Summary

Methods

Modifier and Type	Method and Description
IVariable	createOutputVariable(java.lang.String name, java.lang.String value) Given a name and a value, this method will create an instance of IVariable.
java.util.Iterator<IParameter>	getAllInputParameters() Retrieve a list of all input parameters.
java.util.Iterator<IVariable>	getAllOutputVariables() Retrieve a list of all output variables.
IParameter	getInputParameter(java.lang.String name) Given the name of the parameter, this method will return the IParameter object for it.
IVariable	getOutputVariable(java.lang.String name) Given the name of the variable, this method will return the IVariable object for it.
void	setOutputVariable(IVariable variable) This is a way of updating an output variable in case the value has changed since the variable was created.

Method Detail

getInputParameter

IParameter getInputParameter(java.lang.String name)

Given the name of the parameter, this method will return the IParameter object for it. If the parameter is not set, this will return a value of null. A parameter name of null, empty string or a string that only contains spaces is considered invalid.

Parameters:

name -

Returns:

IParameter object or null if not set or invalid parameter name.

getOutputVariable

IVariable getOutputVariable(java.lang.String name)

Given the name of the variable, this method will return the IVariable object for it. If the Variable is not set, this will return a value of null. A Variable name of null, empty string or a string that only contains spaces is considered invalid.

Parameters:

name -

Returns:

IVariable object or null if not set or invalid Variable name.

createOutputVariable

IVariable createOutputVariable(java.lang.String name,
                             java.lang.String value)

Given a name and a value, this method will create an instance of IVariable. This variable is also added to the list of output variables.

Parameters:

name -

value -

Returns:

setOutputVariable

void setOutputVariable(IVariable variable)

This is a way of updating an output variable in case the value has changed since the variable was created. Please use createOutputVariable(String name, String value) to create a new variable.

Parameters:

variable -

getAllInputParameters

java.util.Iterator<IParameter> getAllInputParameters()

Retrieve a list of all input parameters. The collection returned is an immutable iterator.

Returns:

An iterator of IParameter on all input parameters

getAllOutputVariables

java.util.Iterator<IVariable> getAllOutputVariables()

Retrieve a list of all output variables. The collection returned is an immutable iterator.

Returns:

An iterator of IVaraible on the list of output variables