Package com.uc4.api.objects

Class DynamicSQLVariable

java.lang.Object

com.uc4.api.objects.DynamicSQLVariable

public class DynamicSQLVariable
extends java.lang.Object

Dynamic Database Variable.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DynamicSQLVariable(com.uc4.util.XMLDocument doc)

Method Summary

Modifier and Type	Method	Description
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.
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.
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

Constructor Detail

DynamicSQLVariable

protected DynamicSQLVariable(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