com.uc4.api.objects

Class DynamicExecVariable

java.lang.Object

com.uc4.api.objects.DynamicExecVariable

public class DynamicExecVariable
extends java.lang.Object

Dynamic Executable Variable.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DynamicExecVariable(com.uc4.util.XMLDocument doc) Instantiates a new dynamic Executable variable.

Method Summary

Modifier and Type	Method and Description
java.lang.String	addParameter(java.lang.String vName, java.lang.String value) Adds a new parameter to the Dynamic Executable Variable..
void	clearParameters() Removes all Parameters.
UC4ObjectName	getExecObject() Gets the executable object name.
java.lang.String	getParameter(java.lang.String key) Gets the parameter from given key.
java.lang.String	getResultVariableName() Gets the Variable result name.
java.util.Iterator<java.lang.String>	parameterNameIterator() Returns an java.util.Iterator of set parameter names.
int	paramSize() Number of used parameters.
void	removeParameter(java.lang.String vName) Removes a parameter.
void	setExecObject(UC4ObjectName execObject) Sets the executable object name.
void	setResultVariableName(java.lang.String varaResult) Sets the Variable result name.
protected void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element vara)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DynamicExecVariable

protected DynamicExecVariable(com.uc4.util.XMLDocument doc)

Instantiates a new dynamic Executable variable.

Parameters:

doc - the doc

Method Detail

store

protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element vara)

getExecObject

public UC4ObjectName getExecObject()

Gets the executable object name.

Returns:

the executable object

setExecObject

public void setExecObject(UC4ObjectName execObject)

Sets the executable object name.

Parameters:

execObject - the new Executable object

getResultVariableName

public java.lang.String getResultVariableName()

Gets the Variable result name.

Returns:

the Variable result name

setResultVariableName

public void setResultVariableName(java.lang.String varaResult)

Sets the Variable result name.

Parameters:

varaResult - the new Variable result name

paramSize

public int paramSize()

Number of used parameters.

Returns:

Number of used parameters

removeParameter

public void removeParameter(java.lang.String vName)

Removes a parameter.

Parameters:

vName - Key of the parameter that should be removed

Throws:

java.lang.NullPointerException - the null pointer exception

clearParameters

public void clearParameters()

Removes all Parameters.

addParameter

public java.lang.String addParameter(java.lang.String vName,
                                     java.lang.String value)

Adds a new parameter to the Dynamic Executable Variable.. The returns value indicates if the parameter was added successfully.

Parameters:

vName - name of the parameter

value - value of the parameter

Returns:

true if the bind parameter was added successfully false otherwise

getParameter

public java.lang.String getParameter(java.lang.String key)

Gets the parameter from given key.

Parameters:

key - the key of an specified parameter

Returns:

the value of specified parameter

parameterNameIterator

public java.util.Iterator<java.lang.String> parameterNameIterator()

Returns an java.util.Iterator of set parameter names. Each parameter is stored as java.lang.String.

Returns:

Iterator Names of set parameters