oracle.toplink.queryframework
Class SQLCall

java.lang.Object
  oracle.toplink.internal.databaseaccess.DatasourceCall
      oracle.toplink.internal.databaseaccess.DatabaseCall
          oracle.toplink.queryframework.SQLCall

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, oracle.toplink.internal.databaseaccess.QueryStringCall, Call

public class SQLCall
extends DatabaseCall
implements oracle.toplink.internal.databaseaccess.QueryStringCall

Purpose: Used as an abstraction of an SQL call. A call is an SQL string with parameters.

See Also:

Serialized Form

Constructor Summary

SQLCall()
Create a new SQL call.

SQLCall(java.lang.String sqlString)
Create a new SQL call.

Method Summary

void	setCustomSQLArgumentType(java.lang.String customParameterName, java.lang.Class type) This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
void	setCustomSQLArgumentType(java.lang.String argumentFieldName, int type) This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
void	setCustomSQLArgumentType(java.lang.String argumentFieldName, int type, java.lang.String typeName) This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
void	setCustomSQLArgumentType(java.lang.String argumentFieldName, int type, java.lang.String typeName, java.lang.Class javaType) This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
void	setCustomSQLArgumentType(java.lang.String argumentFieldName, int type, java.lang.String typeName, java.lang.Class javaType, DatabaseField nestedType) This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
void	setCustomSQLArgumentType(java.lang.String argumentFieldName, int type, java.lang.String typeName, DatabaseField nestedType) This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).
void	setSQLString(java.lang.String sqlString) Set the SQL string.
void	useCustomSQLCursorOutputAsResultSet(java.lang.String customParameterName) This method should only be used with custom SQL: Used for Oracle result sets through procedures.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SQLCall

public SQLCall()

Create a new SQL call.

SQLCall

public SQLCall(java.lang.String sqlString)

Create a new SQL call. Warning: Allowing an unverified SQL string to be passed into this method makes your application vulnerable to SQL injection attacks.

Method Detail

setCustomSQLArgumentType

public void setCustomSQLArgumentType(java.lang.String customParameterName,
                                     java.lang.Class type)

This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string).

setCustomSQLArgumentType

public void setCustomSQLArgumentType(java.lang.String argumentFieldName,
                                     int type)

This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string). The argumentFieldName is the field or argument name used in the SQL. The type is the JDBC type code for the parameter.

setCustomSQLArgumentType

public void setCustomSQLArgumentType(java.lang.String argumentFieldName,
                                     int type,
                                     java.lang.String typeName)

This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string). TThe argumentFieldName is the field or argument name used in the SQL. The type is the JDBC type code for the parameter. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types.

setCustomSQLArgumentType

public void setCustomSQLArgumentType(java.lang.String argumentFieldName,
                                     int type,
                                     java.lang.String typeName,
                                     java.lang.Class javaType)

This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string). TThe argumentFieldName is the field or argument name used in the SQL. The type is the JDBC type code for the parameter. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types. The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible.

setCustomSQLArgumentType

public void setCustomSQLArgumentType(java.lang.String argumentFieldName,
                                     int type,
                                     java.lang.String typeName,
                                     DatabaseField nestedType)

This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string). TThe argumentFieldName is the field or argument name used in the SQL. The type is the JDBC type code for the parameter. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types. The nestedType is a DatabaseField with type information set to match the VARRAYs object types

setCustomSQLArgumentType

public void setCustomSQLArgumentType(java.lang.String argumentFieldName,
                                     int type,
                                     java.lang.String typeName,
                                     java.lang.Class javaType,
                                     DatabaseField nestedType)

This method should only be used with custom SQL: it sets a type to IN, OUT or INOUT parameter (prefixed with #, ### or #### in custom SQL string). TThe argumentFieldName is the field or argument name used in the SQL. The type is the JDBC type code for the parameter. The typeName is the JDBC type name, this may be required for ARRAY or STRUCT types. The javaType is the java class to return instead of the ARRAY and STRUCT types if a conversion is possible. The nestedType is a DatabaseField with type information set to match the VARRAYs object types

setSQLString

public void setSQLString(java.lang.String sqlString)

Set the SQL string. Warning: Allowing an unverified SQL string to be passed into this method makes your application vulnerable to SQL injection attacks.

useCustomSQLCursorOutputAsResultSet

public void useCustomSQLCursorOutputAsResultSet(java.lang.String customParameterName)

This method should only be used with custom SQL: Used for Oracle result sets through procedures. It defines OUT parameter (prefixed with ### in custom SQL string) as a cursor output.