Package com.uc4.api.objects
Class SecureSQLVariable
java.lang.Object
com.uc4.api.objects.SecureSQLVariable
Dynamic Database Variable Secure.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Adds a new bind parameter to theSecureSQLVariableIntern
.void
clear()
Removes all bind Parameters.Returns the name of the connection object.getLogin()
Returns the result format.Returns the SQL statement.boolean
Returnstrue
if the LOGIN object from the settings of the currently logged on user should be used.iterator()
Returns anjava.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
(String resultFormat) Sets the result format.void
setSqlStatement
(String sqlStatement) Sets the SQL statement.int
size()
Returns the number of bind parameters.protected void
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 Details
-
SecureSQLVariable
protected SecureSQLVariable(com.uc4.util.XMLDocument doc)
-
-
Method Details
-
store
-
isApplyUserLogin
public boolean isApplyUserLogin()Returnstrue
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
- iftrue
the login name from the user settings will be used.
-
getLogin
- Returns:
- Name of the login object
-
setLogin
Sets the name of the login object.- Parameters:
login
- login object
-
getConnection
Returns the name of the connection object.- Returns:
- Name of the connection object
-
setConnection
Sets the connection object.- Parameters:
connection
- Name of the connection object
-
getSqlStatement
Returns the SQL statement.- Returns:
- SQL Statement
-
setSqlStatement
Sets the SQL statement.- Parameters:
sqlStatement
- SQL Statement
-
getResultFormat
Returns the result format.- Returns:
- Result format
-
setResultFormat
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 successfulfalse
otherwise- Throws:
IndexOutOfBoundsException
- if index is out of bounds
-
clear
public void clear()Removes all bind Parameters. -
add
Adds a new bind parameter to theSecureSQLVariableIntern
. The returns value indicates if the bind parameter was added successfully.- Parameters:
bindParameter
- new bind Parameter- Returns:
true
if the bind parameter was added successfullyfalse
otherwise
-
iterator
Returns anjava.util.Iterator
of bind parameters. Each bind parameter is stored asjava.lang.String
.
-