Package com.uc4.api.objects

Class SecureSQLVariable

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

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected SecureSQLVariable​(com.uc4.util.XMLDocument doc)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean add​(java.lang.String bindParameter)
      Adds a new bind parameter to the SecureSQLVariableIntern.
      void clear()
      Removes all bind Parameters.
      UC4ObjectName getConnection()
      Returns the name of the connection object.
      UC4ObjectName getLogin()  
      java.lang.String getResultFormat()
      Returns the result format.
      java.lang.String getSqlStatement()
      Returns the SQL statement.
      boolean isApplyUserLogin()
      Returns true if the LOGIN object from the settings of the currently logged on user should be used.
      java.util.Iterator<java.lang.String> iterator()
      Returns an java.util.Iterator of bind parameters.
      boolean remove​(int index)
      Removes a bind parameter.
      void setApplyUserLogin​(boolean applyUserLogin)
      Sets or clears the check box "Apply User's Login" in the User interface.
      void setConnection​(UC4ObjectName connection)
      Sets the connection object.
      void setLogin​(UC4ObjectName login)
      Sets the name of the login object.
      void setResultFormat​(java.lang.String resultFormat)
      Sets the result format.
      void setSqlStatement​(java.lang.String sqlStatement)
      Sets the SQL statement.
      int size()
      Returns the number of bind parameters.
      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

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Constructor Detail

      • SecureSQLVariable

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

    • Method Detail

      • store

        protected void store​(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.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 java.lang.String getSqlStatement()
        Returns the SQL statement.
        Returns:
        SQL Statement

      • setSqlStatement

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

      • getResultFormat

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

      • setResultFormat

        public void setResultFormat​(java.lang.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:
        java.lang.IndexOutOfBoundsException - if index is out of bounds

      • clear

        public void clear()
        Removes all bind Parameters.

      • add

        public boolean add​(java.lang.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 java.util.Iterator<java.lang.String> iterator()
        Returns an java.util.Iterator of bind parameters. Each bind parameter is stored as java.lang.String.
        Specified by:
        iterator in interface java.lang.Iterable<java.lang.String>
        Returns:
        Iterator