Package com.uc4.api.objects

Class DynamicExecVariable

java.lang.Object
com.uc4.api.objects.DynamicExecVariable
public class DynamicExecVariable extends Object
Dynamic Executable Variable.

  • Constructor Details

    • DynamicExecVariable

      protected DynamicExecVariable(com.uc4.util.XMLDocument doc)
      Instantiates a new dynamic Executable variable.
      Parameters:
      doc - the doc

  • Method Details

    • store

      protected void store(com.uc4.util.XMLDocument doc, 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 String getResultVariableName()
      Gets the Variable result name.
      Returns:
      the Variable result name

    • setResultVariableName

      public void setResultVariableName(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(String vName)
      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

      public String addParameter(String vName, 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 String getParameter(String key)
      Gets the parameter from given key.
      Parameters:
      key - the key of an specified parameter
      Returns:
      the value of specified parameter

    • parameterNameIterator

      public Iterator<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