com.tplan.robot.scripting

Interface ScopedVariableMap

public interface ScopedVariableMap

Methods of a map supporting variable visibility scopes.

Since:

6.3

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ScopedVariableMap.Scope Variable visibility scopes.
static class	ScopedVariableMap.Var Variable class.

Method Summary

Modifier and Type	Method and Description
ScopedVariableMap.Var	get(Object name, Object owner, ScopedVariableMap.Scope[] scope)
ScopedVariableMap.Var	getGlobal(Object name) Get a global variable.
List<String>	getGlobalVariables() Get all global variables.
ScopedVariableMap.Scope	parseScope(String scope) Parse scope from a string (not case sensitive).
void	put(Object name, Object value, Object owner, ScopedVariableMap.Scope scope) Create a variable.
ScopedVariableMap.Var	remove(Object name, Object owner, ScopedVariableMap.Scope scope) Remove a global variable.

Method Detail

parseScope

ScopedVariableMap.Scope parseScope(String scope)
                            throws IllegalArgumentException

Parse scope from a string (not case sensitive).

Parameters:

scope - a scope as String.

Returns:

the scope.

Throws:

IllegalArgumentException - when the string does not represent a known scope.

getGlobal

ScopedVariableMap.Var getGlobal(Object name)

Get a global variable.

Parameters:

name - variable name.

Returns:

variable value or null if it doesn't exist.

get

ScopedVariableMap.Var get(Object name,
                          Object owner,
                          ScopedVariableMap.Scope[] scope)

put

void put(Object name,
         Object value,
         Object owner,
         ScopedVariableMap.Scope scope)

Create a variable.

Parameters:

name - variable name.

value - variable value.

owner - variable the owner Id used to identify whether the variable is within the specified scope, for example the executing workitem Id.

scope - the scope.

remove

ScopedVariableMap.Var remove(Object name,
                             Object owner,
                             ScopedVariableMap.Scope scope)

Remove a global variable.

Parameters:

name - variable name.

owner - variable the owner Id used to identify whether the variable is within the specified scope, for example the executing workitem Id.

scope - the scope.

Returns:

the removed variable or null if it does not exist.

getGlobalVariables

List<String> getGlobalVariables()

Get all global variables.

Returns:

global variable names.