Package com.uc4.api.objects

Class Variable

java.lang.Object
com.uc4.api.objects.UC4Object
com.uc4.api.objects.Variable
public class Variable extends UC4Object
This class represents UC4 Variable objects.

  • Constructor Details

    • Variable

      public Variable()

  • Method Details

    • loadContent

      protected void loadContent(com.uc4.util.XMLDocument doc, ConnectionAttributes info)

    • sql

      public DynamicSQLVariable sql()
      This method provides access to the SQL settings of this VARA object.
      Returns:
      Object which can be used to read/modify SQL settings of this Variable.

    • sqlIntern

      public DynamicSQLVariableIntern sqlIntern()
      This method provides access to the SQL (Automation Engine DB) settings of this VARA object.
      Returns:
      Object which can be used to read/modify SQL statements

    • sqlSecure

      public SecureSQLVariable sqlSecure()
      This method provides access to the Secure SQL settings of this VARA object.
      Returns:
      Object which can be used to read/modify Secure SQL settings of this Variable.

    • sqlInternSecure

      public SecureSQLVariableIntern sqlInternSecure()
      This method provides access to the Secure SQL (Automation Engine DB) settings of this VARA object.
      Returns:
      Object which can be used to read/modify Secure SQL statements

    • dynamicExecVariable

      public DynamicExecVariable dynamicExecVariable()
      This method provides Dynamic Executable Variable Tab.
      Returns:
      Object which can be used to read/modify Dynamic Executable Variable Tab

    • composite

      public CompositeVariable composite()
      This method provides access to the Composite settings of this VARA object.
      Returns:
      Composite settings

    • fileList

      public FileListVariable fileList()
      This method provides access to the file list panel.
      Returns:
      File list settings

    • backend

      public BackendVariable backend()
      This method provides access to the backend panel.
      Returns:
      backend settings

    • header

      public Header header()
      Returns the header data of this object. This is the information of the header tab in the dialog client.
      Returns:
      header

    • keyIterator

      public Iterator<String> keyIterator()
      Returns an java.util.Iterator of validity keywords. Each validity keyword is stored as java.lang.String. The order of the returned validity keywords is undefined.
      Returns:
      Iterator

    • add

      public void add(String key, String value)
      Adds a new entry to this variable. An IllegalArgumentException is thrown if key or value are not conforming to the current variable attributes.
      Parameters:
      key - Key
      value - Value

    • add

      public void add(String key, String value1, String value2, String value3, String value4, String value5)
      Adds a new entry to this static variable. An IllegalArgumentException is thrown if key or value are not conforming to the current variable attributes.
      Parameters:
      key - Key
      value1 - Value for column 1
      value2 - Value for column 2
      value3 - Value for column 3
      value4 - Value for column 4
      value5 - Value for column 5

    • get

      public String get(String validityKeyword)
      Returns the value for the given validity keyword.
      Parameters:
      validityKeyword - validity keyword
      Returns:
      value

    • getRow

      public String[] getRow(String key)
      Returns all values of the row with the specified key as String array.
      Parameters:
      key - Key, must be unique
      Returns:
      Array of Strings containing the values

    • validate

      public void validate() throws InvalidObjectException
      Description copied from class: UC4Object
      Validates the object. If the object is not valid an InvalidObjectException is thrown.
      Overrides:
      validate in class UC4Object
      Throws:
      InvalidObjectException - If the object is not valid

    • remove

      public boolean remove(String validityKeyword)
      Removes an entry from this variable. The returns value indicates if an entry with the given validity keyword was removed.
      Parameters:
      validityKeyword - validity keyword
      Returns:
      true if the entry was removed false otherwise

    • attributes

      public VariableAttributes attributes()
      Returns attributes of this variable.
      Returns:
      variable attributes

    • storeContent

      protected void storeContent(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes sessionInfo)

    • size

      public int size()
      Returns the number of entries in this variable.
      Returns:
      number of entries

    • removeAll

      public void removeAll()
      Removes all entries in this variable.

    • isExecutable

      public boolean isExecutable()
      Description copied from class: UC4Object
      Returns true if this Object can be executed.
      Specified by:
      isExecutable in class UC4Object
      Returns:
      true if the Object can be executed, false if not.

    • setDuplicateKeysAllowed

      public void setDuplicateKeysAllowed(boolean allowed)
      Allow duplicate keys to be passed for a static variable object. Duplicate keys are all replaced by the first one
      Parameters:
      allowed - true if duplicate keys should be allowed. Default is false