Package com.uc4.api.objects

Class SecureSQLVariable

java.lang.Object
com.uc4.api.objects.SecureSQLVariable
All Implemented Interfaces:
Iterable<String>
public class SecureSQLVariable extends Object implements Iterable<String>
Dynamic Database Variable Secure.

  • Constructor Details

    • SecureSQLVariable

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

  • Method Details

    • store

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

    • isApplyUserLogin

      public boolean isApplyUserLogin()
      Returns true if the LOGIN object from the settings of the currently logged on user should be used.
      Returns:
      true if the LOGIN object

    • setApplyUserLogin

      public void setApplyUserLogin(boolean applyUserLogin)
      Sets or clears the check box "Apply User's Login" in the User interface.
      Parameters:
      applyUserLogin - if true the login name from the user settings will be used.

    • getLogin

      public UC4ObjectName getLogin()
      Returns:
      Name of the login object

    • setLogin

      public void setLogin(UC4ObjectName login)
      Sets the name of the login object.
      Parameters:
      login - login object

    • getConnection

      public UC4ObjectName getConnection()
      Returns the name of the connection object.
      Returns:
      Name of the connection object

    • setConnection

      public void setConnection(UC4ObjectName connection)
      Sets the connection object.
      Parameters:
      connection - Name of the connection object

    • getSqlStatement

      public String getSqlStatement()
      Returns the SQL statement.
      Returns:
      SQL Statement

    • setSqlStatement

      public void setSqlStatement(String sqlStatement)
      Sets the SQL statement.
      Parameters:
      sqlStatement - SQL Statement

    • getResultFormat

      public String getResultFormat()
      Returns the result format.
      Returns:
      Result format

    • setResultFormat

      public void setResultFormat(String resultFormat)
      Sets the result format. The maximum length is 1024 characters.
      Parameters:
      resultFormat - String which contains the result format

    • size

      public int size()
      Returns the number of bind parameters.
      Returns:
      number of bind parameters

    • remove

      public boolean remove(int index)
      Removes a bind parameter.
      Parameters:
      index - Index of bind parameter
      Returns:
      true if remove was successful false otherwise
      Throws:
      IndexOutOfBoundsException - if index is out of bounds

    • clear

      public void clear()
      Removes all bind Parameters.

    • add

      public boolean add(String bindParameter)
      Adds a new bind parameter to the SecureSQLVariableIntern. The returns value indicates if the bind parameter was added successfully.
      Parameters:
      bindParameter - new bind Parameter
      Returns:
      true if the bind parameter was added successfully false otherwise

    • iterator

      public Iterator<String> iterator()
      Returns an java.util.Iterator of bind parameters. Each bind parameter is stored as java.lang.String.
      Specified by:
      iterator in interface Iterable<String>
      Returns:
      Iterator