Package com.uc4.api.objects
Class DynamicExecVariable
java.lang.Object
com.uc4.api.objects.DynamicExecVariable
Dynamic Executable Variable.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
DynamicExecVariable
(com.uc4.util.XMLDocument doc) Instantiates a new dynamic Executable variable. -
Method Summary
Modifier and TypeMethodDescriptionaddParameter
(String vName, String value) Adds a new parameter to theDynamic Executable Variable.
.void
Removes all Parameters.Gets the executable object name.getParameter
(String key) Gets the parameter from given key.Gets the Variable result name.Returns anjava.util.Iterator
of set parameter names.int
Number of used parameters.void
removeParameter
(String vName) Removes a parameter.void
setExecObject
(UC4ObjectName execObject) Sets the executable object name.void
setResultVariableName
(String varaResult) Sets the Variable result name.protected void
-
Constructor Details
-
DynamicExecVariable
protected DynamicExecVariable(com.uc4.util.XMLDocument doc) Instantiates a new dynamic Executable variable.- Parameters:
doc
- the doc
-
-
Method Details
-
store
-
getExecObject
Gets the executable object name.- Returns:
- the executable object
-
setExecObject
Sets the executable object name.- Parameters:
execObject
- the new Executable object
-
getResultVariableName
Gets the Variable result name.- Returns:
- the Variable result name
-
setResultVariableName
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
Removes a parameter.- Parameters:
vName
- Key of the parameter that should be removed- Throws:
NullPointerException
- the null pointer exception
-
clearParameters
public void clearParameters()Removes all Parameters. -
addParameter
Adds a new parameter to theDynamic Executable Variable.
. The returns value indicates if the parameter was added successfully.- Parameters:
vName
- name of the parametervalue
- value of the parameter- Returns:
true
if the bind parameter was added successfullyfalse
otherwise
-
getParameter
Gets the parameter from given key.- Parameters:
key
- the key of an specified parameter- Returns:
- the value of specified parameter
-
parameterNameIterator
Returns anjava.util.Iterator
of set parameter names. Each parameter is stored asjava.lang.String
.- Returns:
- Iterator Names of set parameters
-