FileDocCategorySizeDatePackage
CallableStatementWrapper.javaAPI DocGlassfish v2 API69577Fri May 04 22:36:04 BST 2007com.sun.gjc.spi.base

CallableStatementWrapper

public abstract class CallableStatementWrapper extends PreparedStatementWrapper implements CallableStatement
Abstract class for wrapping PreparedStatement

Fields Summary
protected CallableStatement
callableStatement
Constructors Summary
public CallableStatementWrapper(Connection con, CallableStatement statement)
Creates a new instance of CallableStatementWrapper

param
con ConnectionWrapper
param
statement Statement that is to be wrapped


                            
         
        super(con, statement);
        callableStatement = statement;
    
Methods Summary
public java.sql.ArraygetArray(int i)
Retrieves the value of the designated JDBC ARRAY parameter as an {@link java.sql.Array} object in the Java programming language.

param
i the first parameter is 1, the second is 2, and so on
return
the parameter value as an Array object in the Java programming language. If the value was SQL NULL, the value null is returned.
throws
java.sql.SQLException if a database access error occurs
since
1.2

         return callableStatement.getArray(i);
    
public java.sql.ArraygetArray(java.lang.String parameterName)
Retrieves the value of a JDBC ARRAY parameter as an {@link java.sql.Array} object in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value as an Array object in Java programming language. If the value was SQL NULL, the value null is returned.
throws
java.sql.SQLException if a database access error occurs
since
1.4

        return callableStatement.getArray(parameterName);
    
public java.math.BigDecimalgetBigDecimal(int parameterIndex, int scale)
Retrieves the value of the designated JDBC NUMERIC parameter as a java.math.BigDecimal object with scale digits to the right of the decimal point.

param
parameterIndex the first parameter is 1, the second is 2, and so on
param
scale the number of digits to the right of the decimal point
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setBigDecimal
deprecated
use getBigDecimal(int parameterIndex) or getBigDecimal(String parameterName)

         return callableStatement.getBigDecimal(parameterIndex, scale);
    
public java.math.BigDecimalgetBigDecimal(int parameterIndex)
Retrieves the value of the designated JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value in full precision. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setBigDecimal
since
1.2

         return callableStatement.getBigDecimal(parameterIndex);
    
public java.math.BigDecimalgetBigDecimal(java.lang.String parameterName)
Retrieves the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.

param
parameterName the name of the parameter
return
the parameter value in full precision. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setBigDecimal
since
1.4

        return callableStatement.getBigDecimal(parameterName);
    
public java.sql.BlobgetBlob(int i)
Retrieves the value of the designated JDBC BLOB parameter as a {@link java.sql.Blob} object in the Java programming language.

param
i the first parameter is 1, the second is 2, and so on
return
the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the value null is returned.
throws
java.sql.SQLException if a database access error occurs
since
1.2

         return callableStatement.getBlob(i);
    
public java.sql.BlobgetBlob(java.lang.String parameterName)
Retrieves the value of a JDBC BLOB parameter as a {@link java.sql.Blob} object in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the value null is returned.
throws
java.sql.SQLException if a database access error occurs
since
1.4

        return callableStatement.getBlob(parameterName);
    
public booleangetBoolean(java.lang.String parameterName)
Retrieves the value of a JDBC BIT parameter as a boolean in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is false.
throws
java.sql.SQLException if a database access error occurs
see
#setBoolean
since
1.4

        return callableStatement.getBoolean(parameterName);
    
public booleangetBoolean(int parameterIndex)
Retrieves the value of the designated JDBC BIT parameter as a boolean in the Java programming language.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is false.
throws
java.sql.SQLException if a database access error occurs
see
#setBoolean

        return callableStatement.getBoolean(parameterIndex);
    
public bytegetByte(java.lang.String parameterName)
Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setByte
since
1.4

        return callableStatement.getByte(parameterName);
    
public bytegetByte(int parameterIndex)
Retrieves the value of the designated JDBC TINYINT parameter as a byte in the Java programming language.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setByte

         return callableStatement.getByte(parameterIndex);
    
public byte[]getBytes(int parameterIndex)
Retrieves the value of the designated JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setBytes

         return callableStatement.getBytes(parameterIndex);
    
public byte[]getBytes(java.lang.String parameterName)
Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setBytes
since
1.4

        return callableStatement.getBytes(parameterName);
    
public java.sql.ClobgetClob(int i)
Retrieves the value of the designated JDBC CLOB parameter as a Clob object in the Java programming language.

param
i the first parameter is 1, the second is 2, and so on
return
the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.
throws
java.sql.SQLException if a database access error occurs
since
1.2

         return callableStatement.getClob(i);
    
public java.sql.ClobgetClob(java.lang.String parameterName)
Retrieves the value of a JDBC CLOB parameter as a Clob object in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.
throws
java.sql.SQLException if a database access error occurs
since
1.4

        return callableStatement.getClob(parameterName);
    
public java.sql.DategetDate(int parameterIndex)
Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setDate

         return callableStatement.getDate(parameterIndex);
    
public java.sql.DategetDate(int parameterIndex, java.util.Calendar cal)
Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date. With a Calendar object, the driver can calculate the date taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

param
parameterIndex the first parameter is 1, the second is 2, and so on
param
cal the Calendar object the driver will use to construct the date
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setDate
since
1.2

         return callableStatement.getDate(parameterIndex, cal);
    
public java.sql.DategetDate(java.lang.String parameterName)
Retrieves the value of a JDBC DATE parameter as a java.sql.Date object.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setDate
since
1.4

        return callableStatement.getDate(parameterName);
    
public java.sql.DategetDate(java.lang.String parameterName, java.util.Calendar cal)
Retrieves the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date. With a Calendar object, the driver can calculate the date taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

param
parameterName the name of the parameter
param
cal the Calendar object the driver will use to construct the date
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setDate
since
1.4

        return callableStatement.getDate(parameterName, cal);
    
public doublegetDouble(int parameterIndex)
Retrieves the value of the designated JDBC DOUBLE parameter as a double in the Java programming language.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setDouble

         return callableStatement.getDouble(parameterIndex);
    
public doublegetDouble(java.lang.String parameterName)
Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setDouble
since
1.4

        return callableStatement.getDouble(parameterName);
    
public floatgetFloat(int parameterIndex)
Retrieves the value of the designated JDBC FLOAT parameter as a float in the Java programming language.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setFloat

         return callableStatement.getFloat(parameterIndex);
    
public floatgetFloat(java.lang.String parameterName)
Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setFloat
since
1.4

        return callableStatement.getFloat(parameterName);
    
public intgetInt(java.lang.String parameterName)
Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setInt
since
1.4

        return callableStatement.getInt(parameterName);
    
public intgetInt(int parameterIndex)
Retrieves the value of the designated JDBC INTEGER parameter as an int in the Java programming language.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setInt

         return callableStatement.getInt(parameterIndex);
    
public longgetLong(int parameterIndex)
Retrieves the value of the designated JDBC BIGINT parameter as a long in the Java programming language.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setLong

         return callableStatement.getLong(parameterIndex);
    
public longgetLong(java.lang.String parameterName)
Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setLong
since
1.4

        return callableStatement.getLong(parameterName);
    
public java.lang.ObjectgetObject(int parameterIndex)
Retrieves the value of the designated parameter as an Object in the Java programming language. If the value is an SQL NULL, the driver returns a Java null.

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter. By registering the target JDBC type as java.sql.Types.OTHER, this method can be used to read database-specific abstract data types.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
A java.lang.Object holding the OUT parameter value
throws
java.sql.SQLException if a database access error occurs
see
java.sql.Types
see
#setObject

         return callableStatement.getObject(parameterIndex);
    
public java.lang.ObjectgetObject(java.lang.String parameterName)
Retrieves the value of a parameter as an Object in the Java programming language. If the value is an SQL NULL, the driver returns a Java null.

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter. By registering the target JDBC type as java.sql.Types.OTHER, this method can be used to read database-specific abstract data types.

param
parameterName the name of the parameter
return
A java.lang.Object holding the OUT parameter value.
throws
java.sql.SQLException if a database access error occurs
see
java.sql.Types
see
#setObject
since
1.4

        return callableStatement.getObject(parameterName);
    
public java.lang.ObjectgetObject(int i, java.util.Map map)
Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter. By registering the target JDBC type as java.sql.Types.OTHER, this method can be used to read database-specific abstract data types.

param
i the first parameter is 1, the second is 2, and so on
param
map the mapping from SQL type names to Java classes
return
a java.lang.Object holding the OUT parameter value
throws
java.sql.SQLException if a database access error occurs
see
#setObject
since
1.2

         return callableStatement.getObject(i, map);
    
public java.lang.ObjectgetObject(java.lang.String parameterName, java.util.Map map)
Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter. By registering the target JDBC type as java.sql.Types.OTHER, this method can be used to read database-specific abstract data types.

param
parameterName the name of the parameter
param
map the mapping from SQL type names to Java classes
return
a java.lang.Object holding the OUT parameter value
throws
java.sql.SQLException if a database access error occurs
see
#setObject
since
1.4

        return callableStatement.getObject(parameterName, map);
    
public java.sql.RefgetRef(int i)
Retrieves the value of the designated JDBC REF(<structured-type>) parameter as a {@link java.sql.Ref} object in the Java programming language.

param
i the first parameter is 1, the second is 2, and so on
return
the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the value null is returned.
throws
java.sql.SQLException if a database access error occurs
since
1.2

         return callableStatement.getRef(i);
    
public java.sql.RefgetRef(java.lang.String parameterName)
Retrieves the value of a JDBC REF(<structured-type>) parameter as a {@link java.sql.Ref} object in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the value null is returned.
throws
java.sql.SQLException if a database access error occurs
since
1.4

        return callableStatement.getRef(parameterName);
    
public shortgetShort(java.lang.String parameterName)
Retrieves the value of a JDBC SMALLINT parameter as a short in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setShort
since
1.4

        return callableStatement.getShort(parameterName);
    
public shortgetShort(int parameterIndex)
Retrieves the value of the designated JDBC SMALLINT parameter as a short in the Java programming language.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is 0.
throws
java.sql.SQLException if a database access error occurs
see
#setShort

         return callableStatement.getShort(parameterIndex);
    
public java.lang.StringgetString(int parameterIndex)
Retrieves the value of the designated JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.

For the fixed-length type JDBC CHAR, the String object returned has exactly the same value the JDBC CHAR value had in the database, including any padding added by the database.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setString

        return callableStatement.getString(parameterIndex);
    
public java.lang.StringgetString(java.lang.String parameterName)
Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.

For the fixed-length type JDBC CHAR, the String object returned has exactly the same value the JDBC CHAR value had in the database, including any padding added by the database.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setString
since
1.4

        return callableStatement.getString(parameterName);
    
public java.sql.TimegetTime(int parameterIndex)
Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setTime

         return callableStatement.getTime(parameterIndex);
    
public java.sql.TimegetTime(int parameterIndex, java.util.Calendar cal)
Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time. With a Calendar object, the driver can calculate the time taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

param
parameterIndex the first parameter is 1, the second is 2, and so on
param
cal the Calendar object the driver will use to construct the time
return
the parameter value; if the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setTime
since
1.2

         return callableStatement.getTime(parameterIndex, cal);
    
public java.sql.TimegetTime(java.lang.String parameterName)
Retrieves the value of a JDBC TIME parameter as a java.sql.Time object.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setTime
since
1.4

        return callableStatement.getTime(parameterName);
    
public java.sql.TimegetTime(java.lang.String parameterName, java.util.Calendar cal)
Retrieves the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time. With a Calendar object, the driver can calculate the time taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

param
parameterName the name of the parameter
param
cal the Calendar object the driver will use to construct the time
return
the parameter value; if the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setTime
since
1.4

        return callableStatement.getTime(parameterName, cal);
    
public java.sql.TimestampgetTimestamp(int parameterIndex)
Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setTimestamp

         return callableStatement.getTimestamp(parameterIndex);
    
public java.sql.TimestampgetTimestamp(int parameterIndex, java.util.Calendar cal)
Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object. With a Calendar object, the driver can calculate the timestamp taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

param
parameterIndex the first parameter is 1, the second is 2, and so on
param
cal the Calendar object the driver will use to construct the timestamp
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setTimestamp
since
1.2

         return callableStatement.getTimestamp(parameterIndex, cal);
    
public java.sql.TimestampgetTimestamp(java.lang.String parameterName)
Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

param
parameterName the name of the parameter
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setTimestamp
since
1.4

        return callableStatement.getTimestamp(parameterName);
    
public java.sql.TimestampgetTimestamp(java.lang.String parameterName, java.util.Calendar cal)
Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object. With a Calendar object, the driver can calculate the timestamp taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

param
parameterName the name of the parameter
param
cal the Calendar object the driver will use to construct the timestamp
return
the parameter value. If the value is SQL NULL, the result is null.
throws
java.sql.SQLException if a database access error occurs
see
#setTimestamp
since
1.4

        return callableStatement.getTimestamp(parameterName, cal);
    
public java.net.URLgetURL(int parameterIndex)
Retrieves the value of the designated JDBC DATALINK parameter as a java.net.URL object.

param
parameterIndex the first parameter is 1, the second is 2,...
return
a java.net.URL object that represents the JDBC DATALINK value used as the designated parameter
throws
java.sql.SQLException if a database access error occurs, or if the URL being returned is not a valid URL on the Java platform
see
#setURL
since
1.4

        return callableStatement.getURL(parameterIndex);
    
public java.net.URLgetURL(java.lang.String parameterName)
Retrieves the value of a JDBC DATALINK parameter as a java.net.URL object.

param
parameterName the name of the parameter
return
the parameter value as a java.net.URL object in the Java programming language. If the value was SQL NULL, the value null is returned.
throws
java.sql.SQLException if a database access error occurs, or if there is a problem with the URL
see
#setURL
since
1.4

        return callableStatement.getURL(parameterName);
    
public voidregisterOutParameter(int parameterIndex, int sqlType)
Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

If the JDBC type expected to be returned to this output parameter is specific to this particular database, sqlType should be java.sql.Types.OTHER. The method {@link #getObject} retrieves the value.

param
parameterIndex the first parameter is 1, the second is 2, and so on
param
sqlType the JDBC type code defined by java.sql.Types. If the parameter is of JDBC type NUMERIC or DECIMAL, the version of registerOutParameter that accepts a scale value should be used.
throws
java.sql.SQLException if a database access error occurs
see
java.sql.Types

        callableStatement.registerOutParameter(parameterIndex, sqlType);
    
public voidregisterOutParameter(int paramIndex, int sqlType, java.lang.String typeName)
Registers the designated output parameter. This version of the method registerOutParameter should be used for a user-defined or REF output parameter. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

Before executing a stored procedure call, you must explicitly call registerOutParameter to register the type from java.sql.Types for each OUT parameter. For a user-defined parameter, the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-defined and REF parameters.

Although it is intended for user-defined and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the typeName parameter is ignored.

Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.

param
paramIndex the first parameter is 1, the second is 2,...
param
sqlType a value from {@link java.sql.Types}
param
typeName the fully-qualified name of an SQL structured type
throws
java.sql.SQLException if a database access error occurs
see
java.sql.Types
since
1.2

         callableStatement.registerOutParameter(paramIndex, sqlType, typeName);
    
public voidregisterOutParameter(java.lang.String parameterName, int sqlType)
Registers the OUT parameter named parameterName to the JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

If the JDBC type expected to be returned to this output parameter is specific to this particular database, sqlType should be java.sql.Types.OTHER. The method {@link #getObject} retrieves the value.

param
parameterName the name of the parameter
param
sqlType the JDBC type code defined by java.sql.Types. If the parameter is of JDBC type NUMERIC or DECIMAL, the version of registerOutParameter that accepts a scale value should be used.
throws
java.sql.SQLException if a database access error occurs
see
java.sql.Types
since
1.4

         callableStatement.registerOutParameter(parameterName, sqlType);
    
public voidregisterOutParameter(java.lang.String parameterName, int sqlType, int scale)
Registers the parameter named parameterName to be of JDBC type sqlType. This method must be called before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

param
parameterName the name of the parameter
param
sqlType SQL type code defined by java.sql.Types.
param
scale the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.
throws
java.sql.SQLException if a database access error occurs
see
java.sql.Types
since
1.4

        callableStatement.registerOutParameter(parameterName, sqlType, scale);
    
public voidregisterOutParameter(int parameterIndex, int sqlType, int scale)
Registers the parameter in ordinal position parameterIndex to be of JDBC type sqlType. This method must be called before a stored procedure is executed.

The JDBC type specified by sqlType for an OUT parameter determines the Java type that must be used in the get method to read the value of that parameter.

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

param
parameterIndex the first parameter is 1, the second is 2, and so on
param
sqlType the SQL type code defined by java.sql.Types.
param
scale the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.
throws
java.sql.SQLException if a database access error occurs
see
java.sql.Types

        callableStatement.registerOutParameter(parameterIndex, sqlType, scale);
    
public voidregisterOutParameter(java.lang.String parameterName, int sqlType, java.lang.String typeName)
Registers the designated output parameter. This version of the method registerOutParameter should be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

Before executing a stored procedure call, you must explicitly call registerOutParameter to register the type from java.sql.Types for each OUT parameter. For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters.

Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.

Note: When reading the value of an out parameter, you must use the getXXX method whose Java type XXX corresponds to the parameter's registered SQL type.

param
parameterName the name of the parameter
param
sqlType a value from {@link java.sql.Types}
param
typeName the fully-qualified name of an SQL structured type
throws
java.sql.SQLException if a database access error occurs
see
java.sql.Types
since
1.4

        callableStatement.registerOutParameter(parameterName, sqlType, typeName);
    
public voidsetAsciiStream(java.lang.String parameterName, java.io.InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

param
parameterName the name of the parameter
param
x the Java input stream that contains the ASCII parameter value
param
length the number of bytes in the stream
throws
java.sql.SQLException if a database access error occurs
since
1.4

        callableStatement.setAsciiStream(parameterName, x, length);
    
public voidsetBigDecimal(java.lang.String parameterName, java.math.BigDecimal x)
Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getBigDecimal
since
1.4

        callableStatement.setBigDecimal(parameterName, x);
    
public voidsetBinaryStream(java.lang.String parameterName, java.io.InputStream x, int length)
Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

param
parameterName the name of the parameter
param
x the java input stream which contains the binary parameter value
param
length the number of bytes in the stream
throws
java.sql.SQLException if a database access error occurs
since
1.4

        callableStatement.setBinaryStream(parameterName, x, length);
    
public voidsetBoolean(java.lang.String parameterName, boolean x)
Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getBoolean
since
1.4

        callableStatement.setBoolean(parameterName, x);
    
public voidsetByte(java.lang.String parameterName, byte x)
Sets the designated parameter to the given Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getByte
since
1.4

        callableStatement.setByte(parameterName, x);
    
public voidsetBytes(java.lang.String parameterName, byte[] x)
Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getBytes
since
1.4

        callableStatement.setBytes(parameterName, x);
    
public voidsetCharacterStream(java.lang.String parameterName, java.io.Reader reader, int length)
Sets the designated parameter to the given Reader object, which is the given number of characters long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

param
parameterName the name of the parameter
param
reader the java.io.Reader object that contains the UNICODE data used as the designated parameter
param
length the number of characters in the stream
throws
java.sql.SQLException if a database access error occurs
since
1.4

        callableStatement.setCharacterStream(parameterName, reader, length);
    
public voidsetDate(java.lang.String parameterName, java.sql.Date x)
Sets the designated parameter to the given java.sql.Date value. The driver converts this to an SQL DATE value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getDate
since
1.4

        callableStatement.setDate(parameterName, x);
    
public voidsetDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal)
Sets the designated parameter to the given java.sql.Date value, using the given Calendar object. The driver uses the Calendar object to construct an SQL DATE value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the date taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

param
parameterName the name of the parameter
param
x the parameter value
param
cal the Calendar object the driver will use to construct the date
throws
java.sql.SQLException if a database access error occurs
see
#getDate
since
1.4

        callableStatement.setDate(parameterName, x, cal);
    
public voidsetDouble(java.lang.String parameterName, double x)
Sets the designated parameter to the given Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getDouble
since
1.4

        callableStatement.setDouble(parameterName, x);
    
public voidsetFloat(java.lang.String parameterName, float x)
Sets the designated parameter to the given Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getFloat
since
1.4

        callableStatement.setFloat(parameterName, x);
    
public voidsetInt(java.lang.String parameterName, int x)
Sets the designated parameter to the given Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getInt
since
1.4

        callableStatement.setInt(parameterName, x);
    
public voidsetLong(java.lang.String parameterName, long x)
Sets the designated parameter to the given Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getLong
since
1.4

        callableStatement.setLong(parameterName, x);
    
public voidsetNull(java.lang.String parameterName, int sqlType)
Sets the designated parameter to SQL NULL.

Note: You must specify the parameter's SQL type.

param
parameterName the name of the parameter
param
sqlType the SQL type code defined in java.sql.Types
throws
java.sql.SQLException if a database access error occurs
since
1.4

        callableStatement.setNull(parameterName, sqlType);
    
public voidsetNull(java.lang.String parameterName, int sqlType, java.lang.String typeName)
Sets the designated parameter to SQL NULL. This version of the method setNull should be used for user-defined types and REF type parameters. Examples of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types.

Note: To be portable, applications must give the SQL type code and the fully-qualified SQL type name when specifying a NULL user-defined or REF parameter. In the case of a user-defined type the name is the type name of the parameter itself. For a REF parameter, the name is the type name of the referenced type. If a JDBC driver does not need the type code or type name information, it may ignore it.

Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.

param
parameterName the name of the parameter
param
sqlType a value from java.sql.Types
param
typeName the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQL REF value
throws
java.sql.SQLException if a database access error occurs
since
1.4

        callableStatement.setNull(parameterName, sqlType, typeName);
    
public voidsetObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale)
Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the java.lang equivalent objects should be used.

The given Java object will be converted to the given targetSqlType before being sent to the database.

If the object has a custom mapping (is of a class implementing the interface SQLData), the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Note that this method may be used to pass datatabase- specific abstract data types.

param
parameterName the name of the parameter
param
x the object containing the input parameter value
param
targetSqlType the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.
param
scale for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.
throws
java.sql.SQLException if a database access error occurs
see
java.sql.Types
see
#getObject
since
1.4

        callableStatement.setObject(parameterName, x, targetSqlType, scale);
    
public voidsetObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType)
Sets the value of the designated parameter with the given object. This method is like the method setObject above, except that it assumes a scale of zero.

param
parameterName the name of the parameter
param
x the object containing the input parameter value
param
targetSqlType the SQL type (as defined in java.sql.Types) to be sent to the database
throws
java.sql.SQLException if a database access error occurs
see
#getObject
since
1.4

        callableStatement.setObject(parameterName, x, targetSqlType);
    
public voidsetObject(java.lang.String parameterName, java.lang.Object x)
Sets the value of the designated parameter with the given object. The second parameter must be of type Object; therefore, the java.lang equivalent objects should be used for built-in types.

The JDBC specification specifies a standard mapping from Java Object types to SQL types. The given argument will be converted to the corresponding SQL type before being sent to the database.

Note that this method may be used to pass datatabase- specific abstract data types, by using a driver-specific Java type.

If the object is of a class implementing the interface SQLData, the JDBC driver should call the method SQLData.writeSQL to write it to the SQL data stream. If, on the other hand, the object is of a class implementing Ref, Blob, Clob, Struct, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

This method throws an exception if there is an ambiguity, for example, if the object is of a class implementing more than one of the interfaces named above.

param
parameterName the name of the parameter
param
x the object containing the input parameter value
throws
java.sql.SQLException if a database access error occurs or if the given Object parameter is ambiguous
see
#getObject
since
1.4

        callableStatement.setObject(parameterName, x);
    
public voidsetShort(java.lang.String parameterName, short x)
Sets the designated parameter to the given Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getShort
since
1.4

        callableStatement.setShort(parameterName, x);
    
public voidsetString(java.lang.String parameterName, java.lang.String x)
Sets the designated parameter to the given Java String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getString
since
1.4

        callableStatement.setString(parameterName, x);
    
public voidsetTime(java.lang.String parameterName, java.sql.Time x)
Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getTime
since
1.4

        callableStatement.setTime(parameterName, x);
    
public voidsetTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal)
Sets the designated parameter to the given java.sql.Time value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIME value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the time taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

param
parameterName the name of the parameter
param
x the parameter value
param
cal the Calendar object the driver will use to construct the time
throws
java.sql.SQLException if a database access error occurs
see
#getTime
since
1.4

        callableStatement.setTime(parameterName, x, cal);
    
public voidsetTimestamp(java.lang.String parameterName, java.sql.Timestamp x)
Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
java.sql.SQLException if a database access error occurs
see
#getTimestamp
since
1.4

        callableStatement.setTimestamp(parameterName, x);
    
public voidsetTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal)
Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIMESTAMP value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the timestamp taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

param
parameterName the name of the parameter
param
x the parameter value
param
cal the Calendar object the driver will use to construct the timestamp
throws
java.sql.SQLException if a database access error occurs
see
#getTimestamp
since
1.4

        callableStatement.setTimestamp(parameterName, x, cal);
    
public voidsetURL(java.lang.String parameterName, java.net.URL val)
Sets the designated parameter to the given java.net.URL object. The driver converts this to an SQL DATALINK value when it sends it to the database.

param
parameterName the name of the parameter
param
val the parameter value
throws
java.sql.SQLException if a database access error occurs, or if a URL is malformed
see
#getURL
since
1.4

        callableStatement.setURL(parameterName, val);
    
public booleanwasNull()
Retrieves whether the last OUT parameter read had the value of SQL NULL. Note that this method should be called only after calling a getter method; otherwise, there is no value to use in determining whether it is null or not.

return
true if the last parameter read was SQL NULL; false otherwise
throws
java.sql.SQLException if a database access error occurs

        return callableStatement.wasNull();