FileDocCategorySizeDatePackage
CallableStatement.javaAPI DocJava SE 6 API116634Tue Jun 10 00:25:48 BST 2008java.sql

CallableStatement

public interface CallableStatement implements PreparedStatement
The interface used to execute SQL stored procedures. The JDBC API provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output or both. Parameters are referred to sequentially, by number, with the first parameter being 1.
{?= call <procedure-name>[(<arg1>,<arg2>, ...)]}
{call <procedure-name>[(<arg1>,<arg2>, ...)]}

IN parameter values are set using the set methods inherited from {@link PreparedStatement}. The type of all OUT parameters must be registered prior to executing the stored procedure; their values are retrieved after execution via the get methods provided here.

A CallableStatement can return one {@link ResultSet} object or multiple ResultSet objects. Multiple ResultSet objects are handled using operations inherited from {@link Statement}.

For maximum portability, a call's ResultSet objects and update counts should be processed prior to getting the values of output parameters.

see
Connection#prepareCall
see
ResultSet

Fields Summary
Constructors Summary
Methods Summary
public java.sql.ArraygetArray(int parameterIndex)
Retrieves the value of the designated JDBC ARRAY parameter as an {@link java.sql.Array} object in the Java programming language.

param
parameterIndex 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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
deprecated
use getBigDecimal(int parameterIndex) or getBigDecimal(String parameterName)
see
#setBigDecimal

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setBigDecimal
since
1.2

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.
exception
SQLExceptionif parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setBigDecimal
since
1.4

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

param
parameterIndex 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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4

public booleangetBoolean(int parameterIndex)
Retrieves the value of the designated JDBC BIT or BOOLEAN 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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setBoolean

public booleangetBoolean(java.lang.String parameterName)
Retrieves the value of a JDBC BIT or BOOLEAN 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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setBoolean
since
1.4

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setByte
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setByte

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setBytes

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setBytes
since
1.4

public java.io.ReadergetCharacterStream(int parameterIndex)
Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.

return
a java.io.Reader object that contains the parameter value; if the value is SQL NULL, the value returned is null in the Java programming language.
param
parameterIndex the first parameter is 1, the second is 2, ...
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
since
1.6

public java.io.ReadergetCharacterStream(java.lang.String parameterName)
Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.

param
parameterName the name of the parameter
return
a java.io.Reader object that contains the parameter value; if the value is SQL NULL, the value returned is null in the Java programming language
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public java.sql.ClobgetClob(int parameterIndex)
Retrieves the value of the designated JDBC CLOB parameter as a java.sql.Clob object in the Java programming language.

param
parameterIndex 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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

public java.sql.ClobgetClob(java.lang.String parameterName)
Retrieves the value of a JDBC CLOB parameter as a java.sql.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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setDate

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setDate
since
1.2

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setDate
since
1.4

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setDate
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setDouble

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setDouble
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setFloat

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setFloat
since
1.4

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setInt
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setInt

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setLong
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setLong

public java.io.ReadergetNCharacterStream(int parameterIndex)
Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language. It is intended for use when accessing NCHAR,NVARCHAR and LONGNVARCHAR parameters.

return
a java.io.Reader object that contains the parameter value; if the value is SQL NULL, the value returned is null in the Java programming language.
param
parameterIndex the first parameter is 1, the second is 2, ...
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public java.io.ReadergetNCharacterStream(java.lang.String parameterName)
Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language. It is intended for use when accessing NCHAR,NVARCHAR and LONGNVARCHAR parameters.

param
parameterName the name of the parameter
return
a java.io.Reader object that contains the parameter value; if the value is SQL NULL, the value returned is null in the Java programming language
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public java.sql.NClobgetNClob(int parameterIndex)
Retrieves the value of the designated JDBC NCLOB parameter as a java.sql.NClob object in the Java programming language.

param
parameterIndex the first parameter is 1, the second is 2, and so on
return
the parameter value as a NClob object in the Java programming language. If the value was SQL NULL, the value null is returned.
exception
SQLException if the parameterIndex is not valid; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public java.sql.NClobgetNClob(java.lang.String parameterName)
Retrieves the value of a JDBC NCLOB parameter as a java.sql.NClob object in the Java programming language.

param
parameterName the name of the parameter
return
the parameter value as a NClob object in the Java programming language. If the value was SQL NULL, the value null is returned.
exception
SQLException if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public java.lang.StringgetNString(int parameterIndex)
Retrieves the value of the designated NCHAR, NVARCHAR or LONGNVARCHAR parameter as a String in the Java programming language.

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

param
parameterIndex index of the first parameter is 1, the second is 2, ...
return
a String object that maps an NCHAR, NVARCHAR or LONGNVARCHAR value
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6
see
#setNString

public java.lang.StringgetNString(java.lang.String parameterName)
Retrieves the value of the designated NCHAR, NVARCHAR or LONGNVARCHAR parameter as a String in the Java programming language.

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

param
parameterName the name of the parameter
return
a String object that maps an NCHAR, NVARCHAR or LONGNVARCHAR value
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6
see
#setNString

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
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
Types
see
#setObject

public java.lang.ObjectgetObject(int parameterIndex, java.util.Map map)
Returns an object representing the value of OUT parameter parameterIndex 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
parameterIndex 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
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setObject
since
1.2

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
Types
see
#setObject
since
1.4

public java.lang.ObjectgetObject(java.lang.String parameterName, java.util.Map map)
Returns an object representing the value of OUT parameter parameterName 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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setObject
since
1.4

public java.sql.RefgetRef(int parameterIndex)
Retrieves the value of the designated JDBC REF(<structured-type>) parameter as a {@link java.sql.Ref} object in the Java programming language.

param
parameterIndex 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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.2

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4

public java.sql.RowIdgetRowId(int parameterIndex)
Retrieves the value of the designated JDBC ROWID parameter as a java.sql.RowId object.

param
parameterIndex the first parameter is 1, the second is 2,...
return
a RowId object that represents the JDBC ROWID value is used as the designated parameter. If the parameter contains a SQL NULL, then a null value is returned.
throws
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public java.sql.RowIdgetRowId(java.lang.String parameterName)
Retrieves the value of the designated JDBC ROWID parameter as a java.sql.RowId object.

param
parameterName the name of the parameter
return
a RowId object that represents the JDBC ROWID value is used as the designated parameter. If the parameter contains a SQL NULL, then a null value is returned.
throws
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public java.sql.SQLXMLgetSQLXML(int parameterIndex)
Retrieves the value of the designated SQL XML parameter as a java.sql.SQLXML object in the Java programming language.

param
parameterIndex index of the first parameter is 1, the second is 2, ...
return
a SQLXML object that maps an SQL XML value
throws
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public java.sql.SQLXMLgetSQLXML(java.lang.String parameterName)
Retrieves the value of the designated SQL XML parameter as a java.sql.SQLXML object in the Java programming language.

param
parameterName the name of the parameter
return
a SQLXML object that maps an SQL XML value
throws
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setShort
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setShort

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 SQL 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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setString

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 SQL 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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setString
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setTime

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setTime
since
1.2

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setTime
since
1.4

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setTime
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setTimestamp

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
see
#setTimestamp
since
1.2

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setTimestamp
since
1.4

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setTimestamp
since
1.4

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
exception
SQLException if the parameterIndex is not valid; if a database access error occurs, this method is called on a closed CallableStatement, or if the URL being returned is not a valid URL on the Java platform
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setURL
since
1.4

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs, this method is called on a closed CallableStatement, or if there is a problem with the URL
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#setURL
since
1.4

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type
see
Types

public voidregisterOutParameter(int parameterIndex, int sqlType, int scale)
Registers the parameter in ordinal position parameterIndex to be of 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.

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.
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type
see
Types

public voidregisterOutParameter(int parameterIndex, 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.

All OUT parameters must be registered before a stored procedure is executed.

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
parameterIndex 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
exception
SQLException if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type
see
Types
since
1.2

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method
since
1.4
see
Types

public voidregisterOutParameter(java.lang.String parameterName, int sqlType, int scale)
Registers the parameter named parameterName to be of 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.

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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method
since
1.4
see
Types

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.

All OUT parameters must be registered before a stored procedure is executed.

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if sqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method
see
Types
since
1.4

public voidsetAsciiStream(java.lang.String parameterName, java.io.InputStream x, long 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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetAsciiStream(java.lang.String parameterName, java.io.InputStream x)
Sets the designated parameter to the given input stream. 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.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setAsciiStream which takes a length parameter.

param
parameterName the name of the parameter
param
x the Java input stream that contains the ASCII parameter value
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
throws
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getBigDecimal
since
1.4

public voidsetBinaryStream(java.lang.String parameterName, java.io.InputStream x, long 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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetBinaryStream(java.lang.String parameterName, java.io.InputStream x)
Sets the designated parameter to the given input stream. 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.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBinaryStream which takes a length parameter.

param
parameterName the name of the parameter
param
x the java input stream which contains the binary parameter value
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
throws
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4

public voidsetBlob(java.lang.String parameterName, java.sql.Blob x)
Sets the designated parameter to the given java.sql.Blob object. The driver converts this to an SQL BLOB value when it sends it to the database.

param
parameterName the name of the parameter
param
x a Blob object that maps an SQL BLOB value
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetBlob(java.lang.String parameterName, java.io.InputStream inputStream)
Sets the designated parameter to a InputStream object. This method differs from the setBinaryStream (int, InputStream) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGVARBINARY or a BLOB

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBlob which takes a length parameter.

param
parameterName the name of the parameter
param
inputStream An object that contains the data to set the parameter value to.
throws
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
throws
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetBlob(java.lang.String parameterName, java.io.InputStream inputStream, long length)
Sets the designated parameter to a InputStream object. The inputstream must contain the number of characters specified by length, otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a BLOB. When the setBinaryStream method is used, the driver may have to do extra work to determine whether the parameter data should be sent to the server as a LONGVARBINARY or a BLOB

param
parameterName the name of the parameter to be set the second is 2, ...
param
inputStream An object that contains the data to set the parameter value to.
param
length the number of bytes in the parameter data.
throws
SQLException if parameterName does not correspond to a named parameter; if the length specified is less than zero; if the number of bytes in the inputstream does not match the specfied length; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

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 or BOOLEAN value when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
see
#getBoolean
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getByte
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getBytes
since
1.4

public voidsetCharacterStream(java.lang.String parameterName, java.io.Reader reader, long 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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetCharacterStream(java.lang.String parameterName, java.io.Reader reader)
Sets the designated parameter to the given Reader object. 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.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setCharacterStream which takes a length parameter.

param
parameterName the name of the parameter
param
reader the java.io.Reader object that contains the Unicode data
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
throws
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4

public voidsetClob(java.lang.String parameterName, java.sql.Clob x)
Sets the designated parameter to the given java.sql.Clob object. The driver converts this to an SQL CLOB value when it sends it to the database.

param
parameterName the name of the parameter
param
x a Clob object that maps an SQL CLOB value
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetClob(java.lang.String parameterName, java.io.Reader reader)
Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGVARCHAR or a CLOB

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setClob which takes a length parameter.

param
parameterName the name of the parameter
param
reader An object that contains the data to set the parameter value to.
throws
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
throws
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetClob(java.lang.String parameterName, java.io.Reader reader, long length)
Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a CLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGVARCHAR or a CLOB

param
parameterName the name of the parameter to be set
param
reader An object that contains the data to set the parameter value to.
param
length the number of characters in the parameter data.
throws
SQLException if parameterName does not correspond to a named parameter; if the length specified is less than zero; a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetDate(java.lang.String parameterName, java.sql.Date x)
Sets the designated parameter to the given java.sql.Date value using the default time zone of the virtual machine that is running the application. 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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getDate
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getDate
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getDouble
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getFloat
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getInt
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getLong
since
1.4

public voidsetNCharacterStream(java.lang.String parameterName, java.io.Reader value)
Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.

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

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNCharacterStream which takes a length parameter.

param
parameterName the name of the parameter
param
value the parameter value
throws
SQLException if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs; or this method is called on a closed CallableStatement
throws
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetNCharacterStream(java.lang.String parameterName, java.io.Reader value, long length)
Sets the designated parameter to a Reader object. The Reader reads the data till end-of-file is reached. The driver does the necessary conversion from Java character format to the national character set in the database.

param
parameterName the name of the parameter to be set
param
value the parameter value
param
length the number of characters in the parameter data.
throws
SQLException if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetNClob(java.lang.String parameterName, java.io.Reader reader)
Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGNVARCHAR or a NCLOB

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNClob which takes a length parameter.

param
parameterName the name of the parameter
param
reader An object that contains the data to set the parameter value to.
throws
SQLException if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
throws
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetNClob(java.lang.String parameterName, java.sql.NClob value)
Sets the designated parameter to a java.sql.NClob object. The object implements the java.sql.NClob interface. This NClob object maps to a SQL NCLOB.

param
parameterName the name of the parameter to be set
param
value the parameter value
throws
SQLException if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetNClob(java.lang.String parameterName, java.io.Reader reader, long length)
Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a NCLOB. When the setCharacterStream method is used, the driver may have to do extra work to determine whether the parameter data should be send to the server as a LONGNVARCHAR or a NCLOB

param
parameterName the name of the parameter to be set
param
reader An object that contains the data to set the parameter value to.
param
length the number of characters in the parameter data.
throws
SQLException if parameterName does not correspond to a named parameter; if the length specified is less than zero; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetNString(java.lang.String parameterName, java.lang.String value)
Sets the designated parameter to the given String object. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR

param
parameterName the name of the parameter to be set
param
value the parameter value
throws
SQLException if parameterName does not correspond to a named parameter; if the driver does not support national character sets; if the driver can detect that a data conversion error could occur; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4

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.

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.4

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, NClob, Struct, java.net.URL, 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.
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if targetSqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type
see
Types
see
#getObject
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if targetSqlType is a ARRAY, BLOB, CLOB, DATALINK, JAVA_OBJECT, NCHAR, NCLOB, NVARCHAR, LONGNVARCHAR, REF, ROWID, SQLXML or STRUCT data type and the JDBC driver does not support this data type
see
#getObject
since
1.4

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, NClob, Struct, java.net.URL, 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.

Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the setNull or the setObject(String parameterName, Object x, int sqlType) method should be used instead of setObject(String parameterName, Object x).

param
parameterName the name of the parameter
param
x the object containing the input parameter value
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs, this method is called on a closed CallableStatement or if the given Object parameter is ambiguous
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getObject
since
1.4

public voidsetRowId(java.lang.String parameterName, java.sql.RowId x)
Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID when it sends it to the database.

param
parameterName the name of the parameter
param
x the parameter value
throws
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

public voidsetSQLXML(java.lang.String parameterName, java.sql.SQLXML xmlObject)
Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database.

param
parameterName the name of the parameter
param
xmlObject a SQLXML object that maps an SQL XML value
throws
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs; this method is called on a closed CallableStatement or the java.xml.transform.Result, Writer or OutputStream has not been closed for the SQLXML object
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
since
1.6

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getShort
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getString
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getTime
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getTime
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getTimestamp
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed CallableStatement
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getTimestamp
since
1.4

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
exception
SQLException if parameterName does not correspond to a named parameter; if a database access error occurs; this method is called on a closed CallableStatement or if a URL is malformed
exception
SQLFeatureNotSupportedException if the JDBC driver does not support this method
see
#getURL
since
1.4

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
exception
SQLException if a database access error occurs or this method is called on a closed CallableStatement