com.jbbres.lib.actions.tools.elements.variables
Class VariableActionParameters

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable<java.lang.Object,java.lang.Object>
          java.util.Properties
              com.jbbres.lib.actions.elements.Parameters
                  com.jbbres.lib.actions.tools.elements.variables.VariableActionParameters

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.Object,java.lang.Object>

public class VariableActionParameters
extends Parameters

The specifics Parameters for VariableAction.

Since:

1.0.0

Version:

1.0.0

Author:

Jean-Baptiste Bres

See Also:

Serialized Form

Field Summary

static java.lang.String	ASSIGN_VALUE The key associated to the assign value parameter.
static java.lang.String	SELECTED_VARIABLE The key associated to the selected variable parameter.

Constructor Summary

VariableActionParameters()
Instantiates a new object.

VariableActionParameters(Variable variable)
Instantiates a new object.

VariableActionParameters(Variable variable, boolean affectValue)
Instantiates a new vobject.

Method Summary

static Variable	getVariable(Workflow workflow, Parameters parameters) Returns the variable referenced in a VariableActionParameters.
static boolean	isAssignValue(Parameters parameters) Returns the assign value flag referenced in a VariableActionParameters.

Methods inherited from class com.jbbres.lib.actions.elements.Parameters

getBooleanParameter, getDoubleParameter, getFloatParameter, getIntParameter, getLongParameter, getParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter

Methods inherited from class java.util.Properties

getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, remove, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SELECTED_VARIABLE

public static final java.lang.String SELECTED_VARIABLE

The key associated to the selected variable parameter.

See Also:

Constant Field Values

ASSIGN_VALUE

public static final java.lang.String ASSIGN_VALUE

The key associated to the assign value parameter.

See Also:

Constant Field Values

Constructor Detail

VariableActionParameters

public VariableActionParameters()

Instantiates a new object.

VariableActionParameters

public VariableActionParameters(Variable variable)

Instantiates a new object.

Parameters:

variable - - the variable

VariableActionParameters

public VariableActionParameters(Variable variable,
                                boolean affectValue)

Instantiates a new vobject.

Parameters:

variable - - the variable

affectValue - - the affect value flag

Method Detail

getVariable

public static Variable getVariable(Workflow workflow,
                                   Parameters parameters)

Returns the variable referenced in a VariableActionParameters.

Parameters:

workflow - - the current workflow

parameters - - the parameters

Returns:

the variable

isAssignValue

public static boolean isAssignValue(Parameters parameters)

Returns the assign value flag referenced in a VariableActionParameters.

Parameters:

parameters - - the parameters

Returns:

the assign value flag