CallableStatement (Java 2 Platform SE 5.0) (original) (raw)

java.sql

Interface CallableStatement

All Superinterfaces:

public interface CallableStatement

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 [,, ...]} {call [,, ...]}

IN parameter values are set using the set methods inherited fromPreparedStatement. 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 ResultSet object or multiple ResultSet objects. Multiple ResultSet objects are handled using operations inherited from Statement.

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

Field Summary

Fields inherited from interface java.sql.Statement
CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Method Summary
Array	getArray(int i) Retrieves the value of the designated JDBC ARRAY parameter as anArray object in the Java programming language.
Array	getArray(String parameterName) Retrieves the value of a JDBC ARRAY parameter as anArray object in the Java programming language.
BigDecimal	getBigDecimal(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.
BigDecimal	[getBigDecimal](../../java/sql/CallableStatement.html#getBigDecimal%28int, int%29)(int parameterIndex, int scale) Deprecated. use getBigDecimal(int parameterIndex) or getBigDecimal(String parameterName)
BigDecimal	getBigDecimal(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.
Blob	getBlob(int i) Retrieves the value of the designated JDBC BLOB parameter as aBlob object in the Java programming language.
Blob	getBlob(String parameterName) Retrieves the value of a JDBC BLOB parameter as aBlob object in the Java programming language.
boolean	getBoolean(int parameterIndex) Retrieves the value of the designated JDBC BIT parameter as a boolean in the Java programming language.
boolean	getBoolean(String parameterName) Retrieves the value of a JDBC BIT parameter as aboolean in the Java programming language.
byte	getByte(int parameterIndex) Retrieves the value of the designated JDBC TINYINT parameter as a byte in the Java programming language.
byte	getByte(String parameterName) Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.
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.
byte[]	getBytes(String parameterName) Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
Clob	getClob(int i) Retrieves the value of the designated JDBC CLOB parameter as aClob object in the Java programming language.
Clob	getClob(String parameterName) Retrieves the value of a JDBC CLOB parameter as aClob object in the Java programming language.
Date	getDate(int parameterIndex) Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object.
Date	[getDate](../../java/sql/CallableStatement.html#getDate%28int, java.util.Calendar%29)(int parameterIndex,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.
Date	getDate(String parameterName) Retrieves the value of a JDBC DATE parameter as a java.sql.Date object.
Date	[getDate](../../java/sql/CallableStatement.html#getDate%28java.lang.String, java.util.Calendar%29)(String parameterName,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.
double	getDouble(int parameterIndex) Retrieves the value of the designated JDBC DOUBLE parameter as a double in the Java programming language.
double	getDouble(String parameterName) Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.
float	getFloat(int parameterIndex) Retrieves the value of the designated JDBC FLOAT parameter as a float in the Java programming language.
float	getFloat(String parameterName) Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.
int	getInt(int parameterIndex) Retrieves the value of the designated JDBC INTEGER parameter as an int in the Java programming language.
int	getInt(String parameterName) Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.
long	getLong(int parameterIndex) Retrieves the value of the designated JDBC BIGINT parameter as a long in the Java programming language.
long	getLong(String parameterName) Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.
Object	getObject(int parameterIndex) Retrieves the value of the designated parameter as an Object in the Java programming language.
Object	[getObject](../../java/sql/CallableStatement.html#getObject%28int, java.util.Map%29)(int i,Map<String,Class<?>> map) Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.
Object	getObject(String parameterName) Retrieves the value of a parameter as an Object in the Java programming language.
Object	[getObject](../../java/sql/CallableStatement.html#getObject%28java.lang.String, java.util.Map%29)(String parameterName,Map<String,Class<?>> map) Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.
Ref	getRef(int i) Retrieves the value of the designated JDBC REF() parameter as a Ref object in the Java programming language.
Ref	getRef(String parameterName) Retrieves the value of a JDBC REF() parameter as a Ref object in the Java programming language.
short	getShort(int parameterIndex) Retrieves the value of the designated JDBC SMALLINT parameter as a short in the Java programming language.
short	getShort(String parameterName) Retrieves the value of a JDBC SMALLINT parameter as a short in the Java programming language.
String	getString(int parameterIndex) Retrieves the value of the designated JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
String	getString(String parameterName) Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
Time	getTime(int parameterIndex) Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object.
Time	[getTime](../../java/sql/CallableStatement.html#getTime%28int, java.util.Calendar%29)(int parameterIndex,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.
Time	getTime(String parameterName) Retrieves the value of a JDBC TIME parameter as a java.sql.Time object.
Time	[getTime](../../java/sql/CallableStatement.html#getTime%28java.lang.String, java.util.Calendar%29)(String parameterName,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.
Timestamp	getTimestamp(int parameterIndex) Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
Timestamp	[getTimestamp](../../java/sql/CallableStatement.html#getTimestamp%28int, java.util.Calendar%29)(int parameterIndex,Calendar cal) Retrieves the value of the designated JDBC TIMESTAMP parameter as ajava.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
Timestamp	getTimestamp(String parameterName) Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
Timestamp	[getTimestamp](../../java/sql/CallableStatement.html#getTimestamp%28java.lang.String, java.util.Calendar%29)(String parameterName,Calendar cal) Retrieves the value of a JDBC TIMESTAMP parameter as ajava.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
URL	getURL(int parameterIndex) Retrieves the value of the designated JDBC DATALINK parameter as ajava.net.URL object.
URL	getURL(String parameterName) Retrieves the value of a JDBC DATALINK parameter as ajava.net.URL object.
void	[registerOutParameter](../../java/sql/CallableStatement.html#registerOutParameter%28int, int%29)(int parameterIndex, int sqlType) Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType.
void	[registerOutParameter](../../java/sql/CallableStatement.html#registerOutParameter%28int, int, int%29)(int parameterIndex, int sqlType, int scale) Registers the parameter in ordinal positionparameterIndex to be of JDBC typesqlType.
void	[registerOutParameter](../../java/sql/CallableStatement.html#registerOutParameter%28int, int, java.lang.String%29)(int paramIndex, int sqlType,String typeName) Registers the designated output parameter.
void	[registerOutParameter](../../java/sql/CallableStatement.html#registerOutParameter%28java.lang.String, int%29)(String parameterName, int sqlType) Registers the OUT parameter named parameterName to the JDBC type sqlType.
void	[registerOutParameter](../../java/sql/CallableStatement.html#registerOutParameter%28java.lang.String, int, int%29)(String parameterName, int sqlType, int scale) Registers the parameter named parameterName to be of JDBC typesqlType.
void	[registerOutParameter](../../java/sql/CallableStatement.html#registerOutParameter%28java.lang.String, int, java.lang.String%29)(String parameterName, int sqlType,String typeName) Registers the designated output parameter.
void	[setAsciiStream](../../java/sql/CallableStatement.html#setAsciiStream%28java.lang.String, java.io.InputStream, int%29)(String parameterName,InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	[setBigDecimal](../../java/sql/CallableStatement.html#setBigDecimal%28java.lang.String, java.math.BigDecimal%29)(String parameterName,BigDecimal x) Sets the designated parameter to the givenjava.math.BigDecimal value.
void	[setBinaryStream](../../java/sql/CallableStatement.html#setBinaryStream%28java.lang.String, java.io.InputStream, int%29)(String parameterName,InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	[setBoolean](../../java/sql/CallableStatement.html#setBoolean%28java.lang.String, boolean%29)(String parameterName, boolean x) Sets the designated parameter to the given Java boolean value.
void	[setByte](../../java/sql/CallableStatement.html#setByte%28java.lang.String, byte%29)(String parameterName, byte x) Sets the designated parameter to the given Java byte value.
void	[setBytes](../../java/sql/CallableStatement.html#setBytes%28java.lang.String, byte[]%29)(String parameterName, byte[] x) Sets the designated parameter to the given Java array of bytes.
void	[setCharacterStream](../../java/sql/CallableStatement.html#setCharacterStream%28java.lang.String, java.io.Reader, int%29)(String parameterName,Reader reader, int length) Sets the designated parameter to the given Reader object, which is the given number of characters long.
void	[setDate](../../java/sql/CallableStatement.html#setDate%28java.lang.String, java.sql.Date%29)(String parameterName,Date x) Sets the designated parameter to the given java.sql.Date value.
void	[setDate](../../java/sql/CallableStatement.html#setDate%28java.lang.String, java.sql.Date, java.util.Calendar%29)(String parameterName,Date x,Calendar cal) Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
void	[setDouble](../../java/sql/CallableStatement.html#setDouble%28java.lang.String, double%29)(String parameterName, double x) Sets the designated parameter to the given Java double value.
void	[setFloat](../../java/sql/CallableStatement.html#setFloat%28java.lang.String, float%29)(String parameterName, float x) Sets the designated parameter to the given Java float value.
void	[setInt](../../java/sql/CallableStatement.html#setInt%28java.lang.String, int%29)(String parameterName, int x) Sets the designated parameter to the given Java int value.
void	[setLong](../../java/sql/CallableStatement.html#setLong%28java.lang.String, long%29)(String parameterName, long x) Sets the designated parameter to the given Java long value.
void	[setNull](../../java/sql/CallableStatement.html#setNull%28java.lang.String, int%29)(String parameterName, int sqlType) Sets the designated parameter to SQL NULL.
void	[setNull](../../java/sql/CallableStatement.html#setNull%28java.lang.String, int, java.lang.String%29)(String parameterName, int sqlType,String typeName) Sets the designated parameter to SQL NULL.
void	[setObject](../../java/sql/CallableStatement.html#setObject%28java.lang.String, java.lang.Object%29)(String parameterName,Object x) Sets the value of the designated parameter with the given object.
void	[setObject](../../java/sql/CallableStatement.html#setObject%28java.lang.String, java.lang.Object, int%29)(String parameterName,Object x, int targetSqlType) Sets the value of the designated parameter with the given object.
void	[setObject](../../java/sql/CallableStatement.html#setObject%28java.lang.String, java.lang.Object, int, int%29)(String parameterName,Object x, int targetSqlType, int scale) Sets the value of the designated parameter with the given object.
void	[setShort](../../java/sql/CallableStatement.html#setShort%28java.lang.String, short%29)(String parameterName, short x) Sets the designated parameter to the given Java short value.
void	[setString](../../java/sql/CallableStatement.html#setString%28java.lang.String, java.lang.String%29)(String parameterName,String x) Sets the designated parameter to the given Java String value.
void	[setTime](../../java/sql/CallableStatement.html#setTime%28java.lang.String, java.sql.Time%29)(String parameterName,Time x) Sets the designated parameter to the given java.sql.Time value.
void	[setTime](../../java/sql/CallableStatement.html#setTime%28java.lang.String, java.sql.Time, java.util.Calendar%29)(String parameterName,Time x,Calendar cal) Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
void	[setTimestamp](../../java/sql/CallableStatement.html#setTimestamp%28java.lang.String, java.sql.Timestamp%29)(String parameterName,Timestamp x) Sets the designated parameter to the given java.sql.Timestamp value.
void	[setTimestamp](../../java/sql/CallableStatement.html#setTimestamp%28java.lang.String, java.sql.Timestamp, java.util.Calendar%29)(String parameterName,Timestamp x,Calendar cal) Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object.
void	[setURL](../../java/sql/CallableStatement.html#setURL%28java.lang.String, java.net.URL%29)(String parameterName,URL val) Sets the designated parameter to the given java.net.URL object.
boolean	wasNull() Retrieves whether the last OUT parameter read had the value of SQL NULL.

Methods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, [setArray](../../java/sql/PreparedStatement.html#setArray%28int, java.sql.Array%29), [setAsciiStream](../../java/sql/PreparedStatement.html#setAsciiStream%28int, java.io.InputStream, int%29), [setBigDecimal](../../java/sql/PreparedStatement.html#setBigDecimal%28int, java.math.BigDecimal%29), [setBinaryStream](../../java/sql/PreparedStatement.html#setBinaryStream%28int, java.io.InputStream, int%29), [setBlob](../../java/sql/PreparedStatement.html#setBlob%28int, java.sql.Blob%29), [setBoolean](../../java/sql/PreparedStatement.html#setBoolean%28int, boolean%29), [setByte](../../java/sql/PreparedStatement.html#setByte%28int, byte%29), [setBytes](../../java/sql/PreparedStatement.html#setBytes%28int, byte[]%29), [setCharacterStream](../../java/sql/PreparedStatement.html#setCharacterStream%28int, java.io.Reader, int%29), [setClob](../../java/sql/PreparedStatement.html#setClob%28int, java.sql.Clob%29), [setDate](../../java/sql/PreparedStatement.html#setDate%28int, java.sql.Date%29), [setDate](../../java/sql/PreparedStatement.html#setDate%28int, java.sql.Date, java.util.Calendar%29), [setDouble](../../java/sql/PreparedStatement.html#setDouble%28int, double%29), [setFloat](../../java/sql/PreparedStatement.html#setFloat%28int, float%29), [setInt](../../java/sql/PreparedStatement.html#setInt%28int, int%29), [setLong](../../java/sql/PreparedStatement.html#setLong%28int, long%29), [setNull](../../java/sql/PreparedStatement.html#setNull%28int, int%29), [setNull](../../java/sql/PreparedStatement.html#setNull%28int, int, java.lang.String%29), [setObject](../../java/sql/PreparedStatement.html#setObject%28int, java.lang.Object%29), [setObject](../../java/sql/PreparedStatement.html#setObject%28int, java.lang.Object, int%29), [setObject](../../java/sql/PreparedStatement.html#setObject%28int, java.lang.Object, int, int%29), [setRef](../../java/sql/PreparedStatement.html#setRef%28int, java.sql.Ref%29), [setShort](../../java/sql/PreparedStatement.html#setShort%28int, short%29), [setString](../../java/sql/PreparedStatement.html#setString%28int, java.lang.String%29), [setTime](../../java/sql/PreparedStatement.html#setTime%28int, java.sql.Time%29), [setTime](../../java/sql/PreparedStatement.html#setTime%28int, java.sql.Time, java.util.Calendar%29), [setTimestamp](../../java/sql/PreparedStatement.html#setTimestamp%28int, java.sql.Timestamp%29), [setTimestamp](../../java/sql/PreparedStatement.html#setTimestamp%28int, java.sql.Timestamp, java.util.Calendar%29), [setUnicodeStream](../../java/sql/PreparedStatement.html#setUnicodeStream%28int, java.io.InputStream, int%29), [setURL](../../java/sql/PreparedStatement.html#setURL%28int, java.net.URL%29)

Methods inherited from interface java.sql.PreparedStatement

addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, [setArray](../../java/sql/PreparedStatement.html#setArray%28int, java.sql.Array%29), [setAsciiStream](../../java/sql/PreparedStatement.html#setAsciiStream%28int, java.io.InputStream, int%29), [setBigDecimal](../../java/sql/PreparedStatement.html#setBigDecimal%28int, java.math.BigDecimal%29), [setBinaryStream](../../java/sql/PreparedStatement.html#setBinaryStream%28int, java.io.InputStream, int%29), [setBlob](../../java/sql/PreparedStatement.html#setBlob%28int, java.sql.Blob%29), [setBoolean](../../java/sql/PreparedStatement.html#setBoolean%28int, boolean%29), [setByte](../../java/sql/PreparedStatement.html#setByte%28int, byte%29), [setBytes](../../java/sql/PreparedStatement.html#setBytes%28int, byte[]%29), [setCharacterStream](../../java/sql/PreparedStatement.html#setCharacterStream%28int, java.io.Reader, int%29), [setClob](../../java/sql/PreparedStatement.html#setClob%28int, java.sql.Clob%29), [setDate](../../java/sql/PreparedStatement.html#setDate%28int, java.sql.Date%29), [setDate](../../java/sql/PreparedStatement.html#setDate%28int, java.sql.Date, java.util.Calendar%29), [setDouble](../../java/sql/PreparedStatement.html#setDouble%28int, double%29), [setFloat](../../java/sql/PreparedStatement.html#setFloat%28int, float%29), [setInt](../../java/sql/PreparedStatement.html#setInt%28int, int%29), [setLong](../../java/sql/PreparedStatement.html#setLong%28int, long%29), [setNull](../../java/sql/PreparedStatement.html#setNull%28int, int%29), [setNull](../../java/sql/PreparedStatement.html#setNull%28int, int, java.lang.String%29), [setObject](../../java/sql/PreparedStatement.html#setObject%28int, java.lang.Object%29), [setObject](../../java/sql/PreparedStatement.html#setObject%28int, java.lang.Object, int%29), [setObject](../../java/sql/PreparedStatement.html#setObject%28int, java.lang.Object, int, int%29), [setRef](../../java/sql/PreparedStatement.html#setRef%28int, java.sql.Ref%29), [setShort](../../java/sql/PreparedStatement.html#setShort%28int, short%29), [setString](../../java/sql/PreparedStatement.html#setString%28int, java.lang.String%29), [setTime](../../java/sql/PreparedStatement.html#setTime%28int, java.sql.Time%29), [setTime](../../java/sql/PreparedStatement.html#setTime%28int, java.sql.Time, java.util.Calendar%29), [setTimestamp](../../java/sql/PreparedStatement.html#setTimestamp%28int, java.sql.Timestamp%29), [setTimestamp](../../java/sql/PreparedStatement.html#setTimestamp%28int, java.sql.Timestamp, java.util.Calendar%29), [setUnicodeStream](../../java/sql/PreparedStatement.html#setUnicodeStream%28int, java.io.InputStream, int%29), [setURL](../../java/sql/PreparedStatement.html#setURL%28int, java.net.URL%29)

Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, execute, [execute](../../java/sql/Statement.html#execute%28java.lang.String, int%29), [execute](../../java/sql/Statement.html#execute%28java.lang.String, int[]%29), [execute](../../java/sql/Statement.html#execute%28java.lang.String, java.lang.String[]%29), executeBatch, executeQuery, executeUpdate, [executeUpdate](../../java/sql/Statement.html#executeUpdate%28java.lang.String, int%29), [executeUpdate](../../java/sql/Statement.html#executeUpdate%28java.lang.String, int[]%29), [executeUpdate](../../java/sql/Statement.html#executeUpdate%28java.lang.String, java.lang.String[]%29), getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, execute, [execute](../../java/sql/Statement.html#execute%28java.lang.String, int%29), [execute](../../java/sql/Statement.html#execute%28java.lang.String, int[]%29), [execute](../../java/sql/Statement.html#execute%28java.lang.String, java.lang.String[]%29), executeBatch, executeQuery, executeUpdate, [executeUpdate](../../java/sql/Statement.html#executeUpdate%28java.lang.String, int%29), [executeUpdate](../../java/sql/Statement.html#executeUpdate%28java.lang.String, int[]%29), [executeUpdate](../../java/sql/Statement.html#executeUpdate%28java.lang.String, java.lang.String[]%29), getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout

Method Detail

registerOutParameter

void registerOutParameter(int parameterIndex, int sqlType) throws SQLException

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 getObject(int) retrieves the value.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

sqlType - the JDBC type code defined by java.sql.Types. If the parameter is of JDBC type NUMERIC or DECIMAL, the version ofregisterOutParameter that accepts a scale value should be used.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

Types

registerOutParameter

void registerOutParameter(int parameterIndex, int sqlType, int scale) throws SQLException

Registers the parameter in ordinal positionparameterIndex to be of JDBC typesqlType. 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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

sqlType - the SQL type code defined by java.sql.Types.

scale - the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

Types

wasNull

boolean wasNull() throws SQLException

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.

Returns:

true if the last parameter read was SQLNULL; false otherwise

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

getString

String getString(int parameterIndex) throws SQLException

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 JDBCCHAR value had in the database, including any padding added by the database.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setString(java.lang.String, java.lang.String)](../../java/sql/CallableStatement.html#setString%28java.lang.String, java.lang.String%29)

getBoolean

boolean getBoolean(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC BIT parameter as a boolean in the Java programming language.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is false.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setBoolean(java.lang.String, boolean)](../../java/sql/CallableStatement.html#setBoolean%28java.lang.String, boolean%29)

getByte

byte getByte(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC TINYINT parameter as a byte in the Java programming language.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setByte(java.lang.String, byte)](../../java/sql/CallableStatement.html#setByte%28java.lang.String, byte%29)

getShort

short getShort(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC SMALLINT parameter as a short in the Java programming language.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setShort(java.lang.String, short)](../../java/sql/CallableStatement.html#setShort%28java.lang.String, short%29)

getInt

int getInt(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC INTEGER parameter as an int in the Java programming language.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setInt(java.lang.String, int)](../../java/sql/CallableStatement.html#setInt%28java.lang.String, int%29)

getLong

long getLong(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC BIGINT parameter as a long in the Java programming language.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setLong(java.lang.String, long)](../../java/sql/CallableStatement.html#setLong%28java.lang.String, long%29)

getFloat

float getFloat(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC FLOAT parameter as a float in the Java programming language.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setFloat(java.lang.String, float)](../../java/sql/CallableStatement.html#setFloat%28java.lang.String, float%29)

getDouble

double getDouble(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC DOUBLE parameter as a double in the Java programming language.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setDouble(java.lang.String, double)](../../java/sql/CallableStatement.html#setDouble%28java.lang.String, double%29)

getBigDecimal

@Deprecated BigDecimal getBigDecimal(int parameterIndex, int scale) throws SQLException

Deprecated. use getBigDecimal(int parameterIndex) or getBigDecimal(String parameterName)

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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

scale - the number of digits to the right of the decimal point

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setBigDecimal(java.lang.String, java.math.BigDecimal)](../../java/sql/CallableStatement.html#setBigDecimal%28java.lang.String, java.math.BigDecimal%29)

getBytes

byte[] getBytes(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setBytes(java.lang.String, byte[])](../../java/sql/CallableStatement.html#setBytes%28java.lang.String, byte[]%29)

getDate

Date getDate(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setDate(java.lang.String, java.sql.Date)](../../java/sql/CallableStatement.html#setDate%28java.lang.String, java.sql.Date%29)

getTime

Time getTime(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setTime(java.lang.String, java.sql.Time)](../../java/sql/CallableStatement.html#setTime%28java.lang.String, java.sql.Time%29)

getTimestamp

Timestamp getTimestamp(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

[setTimestamp(java.lang.String, java.sql.Timestamp)](../../java/sql/CallableStatement.html#setTimestamp%28java.lang.String, java.sql.Timestamp%29)

getObject

Object getObject(int parameterIndex) throws SQLException

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 methodregisterOutParameter. By registering the target JDBC type as java.sql.Types.OTHER, this method can be used to read database-specific abstract data types.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

A java.lang.Object holding the OUT parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

See Also:

Types, [setObject(java.lang.String, java.lang.Object, int, int)](../../java/sql/CallableStatement.html#setObject%28java.lang.String, java.lang.Object, int, int%29)

getBigDecimal

BigDecimal getBigDecimal(int parameterIndex) throws SQLException

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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value in full precision. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.2

See Also:

[setBigDecimal(java.lang.String, java.math.BigDecimal)](../../java/sql/CallableStatement.html#setBigDecimal%28java.lang.String, java.math.BigDecimal%29)

getObject

Object getObject(int i, Map<String,Class<?>> map) throws SQLException

Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.

Parameters:

i - the first parameter is 1, the second is 2, and so on

map - the mapping from SQL type names to Java classes

Returns:

a java.lang.Object holding the OUT parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.2

See Also:

[setObject(java.lang.String, java.lang.Object, int, int)](../../java/sql/CallableStatement.html#setObject%28java.lang.String, java.lang.Object, int, int%29)

getRef

Ref getRef(int i) throws SQLException

Retrieves the value of the designated JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.

Parameters:

i - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the valuenull is returned.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.2

getBlob

Blob getBlob(int i) throws SQLException

Retrieves the value of the designated JDBC BLOB parameter as aBlob object in the Java programming language.

Parameters:

i - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the valuenull is returned.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.2

getClob

Clob getClob(int i) throws SQLException

Retrieves the value of the designated JDBC CLOB parameter as aClob object in the Java programming language.

Parameters:

i - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.2

getArray

Array getArray(int i) throws SQLException

Retrieves the value of the designated JDBC ARRAY parameter as anArray object in the Java programming language.

Parameters:

i - the first parameter is 1, the second is 2, and so on

Returns:

the parameter value as an Array object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.2

getDate

Date getDate(int parameterIndex, Calendar cal) throws SQLException

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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

cal - the Calendar object the driver will use to construct the date

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.2

See Also:

[setDate(java.lang.String, java.sql.Date)](../../java/sql/CallableStatement.html#setDate%28java.lang.String, java.sql.Date%29)

getTime

Time getTime(int parameterIndex, Calendar cal) throws SQLException

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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

cal - the Calendar object the driver will use to construct the time

Returns:

the parameter value; if the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.2

See Also:

[setTime(java.lang.String, java.sql.Time)](../../java/sql/CallableStatement.html#setTime%28java.lang.String, java.sql.Time%29)

getTimestamp

Timestamp getTimestamp(int parameterIndex, Calendar cal) throws SQLException

Retrieves the value of the designated JDBC TIMESTAMP parameter as ajava.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.

Parameters:

parameterIndex - the first parameter is 1, the second is 2, and so on

cal - the Calendar object the driver will use to construct the timestamp

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.2

See Also:

[setTimestamp(java.lang.String, java.sql.Timestamp)](../../java/sql/CallableStatement.html#setTimestamp%28java.lang.String, java.sql.Timestamp%29)

registerOutParameter

void registerOutParameter(int paramIndex, int sqlType, String typeName) throws SQLException

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 fromjava.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.

Parameters:

paramIndex - the first parameter is 1, the second is 2,...

sqlType - a value from Types

typeName - the fully-qualified name of an SQL structured type

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.2

See Also:

Types

registerOutParameter

void registerOutParameter(String parameterName, int sqlType) throws SQLException

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 getObject(int) retrieves the value.

Parameters:

parameterName - the name of the parameter

sqlType - the JDBC type code defined by java.sql.Types. If the parameter is of JDBC type NUMERIC or DECIMAL, the version ofregisterOutParameter that accepts a scale value should be used.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

Types

registerOutParameter

void registerOutParameter(String parameterName, int sqlType, int scale) throws SQLException

Registers the parameter named parameterName to be of JDBC typesqlType. 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.

Parameters:

parameterName - the name of the parameter

sqlType - SQL type code defined by java.sql.Types.

scale - the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

Types

registerOutParameter

void registerOutParameter(String parameterName, int sqlType, String typeName) throws SQLException

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 fromjava.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.

Parameters:

parameterName - the name of the parameter

sqlType - a value from Types

typeName - the fully-qualified name of an SQL structured type

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

Types

getURL

URL getURL(int parameterIndex) throws SQLException

Retrieves the value of the designated JDBC DATALINK parameter as ajava.net.URL object.

Parameters:

parameterIndex - the first parameter is 1, the second is 2,...

Returns:

a java.net.URL object that represents the JDBC DATALINK value used as the designated parameter

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs, or if the URL being returned is not a valid URL on the Java platform

Since:

1.4

See Also:

[setURL(java.lang.String, java.net.URL)](../../java/sql/CallableStatement.html#setURL%28java.lang.String, java.net.URL%29)

setURL

void setURL(String parameterName, URL val) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

val - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs, or if a URL is malformed

Since:

1.4

See Also:

getURL(int)

setNull

void setNull(String parameterName, int sqlType) throws SQLException

Sets the designated parameter to SQL NULL.

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

Parameters:

parameterName - the name of the parameter

sqlType - the SQL type code defined in java.sql.Types

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

setBoolean

void setBoolean(String parameterName, boolean x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getBoolean(int)

setByte

void setByte(String parameterName, byte x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getByte(int)

setShort

void setShort(String parameterName, short x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getShort(int)

setInt

void setInt(String parameterName, int x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getInt(int)

setLong

void setLong(String parameterName, long x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getLong(int)

setFloat

void setFloat(String parameterName, float x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getFloat(int)

setDouble

void setDouble(String parameterName, double x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getDouble(int)

setBigDecimal

void setBigDecimal(String parameterName, BigDecimal x) throws SQLException

Sets the designated parameter to the givenjava.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[getBigDecimal(int, int)](../../java/sql/CallableStatement.html#getBigDecimal%28int, int%29)

setString

void setString(String parameterName, String x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getString(int)

setBytes

void setBytes(String parameterName, byte[] x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getBytes(int)

setDate

void setDate(String parameterName, Date x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getDate(int)

setTime

void setTime(String parameterName, Time x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getTime(int)

setTimestamp

void setTimestamp(String parameterName, Timestamp x) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getTimestamp(int)

setAsciiStream

void setAsciiStream(String parameterName, InputStream x, int length) throws SQLException

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 ajava.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.

Parameters:

parameterName - the name of the parameter

x - the Java input stream that contains the ASCII parameter value

length - the number of bytes in the stream

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

setBinaryStream

void setBinaryStream(String parameterName, InputStream x, int length) throws SQLException

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 ajava.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.

Parameters:

parameterName - the name of the parameter

x - the java input stream which contains the binary parameter value

length - the number of bytes in the stream

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

setObject

void setObject(String parameterName, Object x, int targetSqlType, int scale) throws SQLException

Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, thejava.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 implementingRef, 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.

Parameters:

parameterName - the name of the parameter

x - the object containing the input parameter value

targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.

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:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

Types, getObject(int)

setObject

void setObject(String parameterName, Object x, int targetSqlType) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

x - the object containing the input parameter value

targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getObject(int)

setObject

void setObject(String parameterName, Object x) throws SQLException

Sets the value of the designated parameter with the given object. The second parameter must be of type Object; therefore, thejava.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 implementingRef, 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.

Parameters:

parameterName - the name of the parameter

x - the object containing the input parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs or if the givenObject parameter is ambiguous

Since:

1.4

See Also:

getObject(int)

setCharacterStream

void setCharacterStream(String parameterName, Reader reader, int length) throws SQLException

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 ajava.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.

Parameters:

parameterName - the name of the parameter

reader - the java.io.Reader object that contains the UNICODE data used as the designated parameter

length - the number of characters in the stream

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

setDate

void setDate(String parameterName, Date x, Calendar cal) throws SQLException

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 noCalendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Parameters:

parameterName - the name of the parameter

x - the parameter value

cal - the Calendar object the driver will use to construct the date

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getDate(int)

setTime

void setTime(String parameterName, Time x, Calendar cal) throws SQLException

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 noCalendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Parameters:

parameterName - the name of the parameter

x - the parameter value

cal - the Calendar object the driver will use to construct the time

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getTime(int)

setTimestamp

void setTimestamp(String parameterName, Timestamp x, Calendar cal) throws SQLException

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 noCalendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Parameters:

parameterName - the name of the parameter

x - the parameter value

cal - the Calendar object the driver will use to construct the timestamp

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

getTimestamp(int)

setNull

void setNull(String parameterName, int sqlType, String typeName) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

sqlType - a value from java.sql.Types

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:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

getString

String getString(String parameterName) throws SQLException

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 JDBCCHAR value had in the database, including any padding added by the database.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setString(java.lang.String, java.lang.String)](../../java/sql/CallableStatement.html#setString%28java.lang.String, java.lang.String%29)

getBoolean

boolean getBoolean(String parameterName) throws SQLException

Retrieves the value of a JDBC BIT parameter as aboolean in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is false.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setBoolean(java.lang.String, boolean)](../../java/sql/CallableStatement.html#setBoolean%28java.lang.String, boolean%29)

getByte

byte getByte(String parameterName) throws SQLException

Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setByte(java.lang.String, byte)](../../java/sql/CallableStatement.html#setByte%28java.lang.String, byte%29)

getShort

short getShort(String parameterName) throws SQLException

Retrieves the value of a JDBC SMALLINT parameter as a short in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setShort(java.lang.String, short)](../../java/sql/CallableStatement.html#setShort%28java.lang.String, short%29)

getInt

int getInt(String parameterName) throws SQLException

Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setInt(java.lang.String, int)](../../java/sql/CallableStatement.html#setInt%28java.lang.String, int%29)

getLong

long getLong(String parameterName) throws SQLException

Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setLong(java.lang.String, long)](../../java/sql/CallableStatement.html#setLong%28java.lang.String, long%29)

getFloat

float getFloat(String parameterName) throws SQLException

Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setFloat(java.lang.String, float)](../../java/sql/CallableStatement.html#setFloat%28java.lang.String, float%29)

getDouble

double getDouble(String parameterName) throws SQLException

Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setDouble(java.lang.String, double)](../../java/sql/CallableStatement.html#setDouble%28java.lang.String, double%29)

getBytes

byte[] getBytes(String parameterName) throws SQLException

Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setBytes(java.lang.String, byte[])](../../java/sql/CallableStatement.html#setBytes%28java.lang.String, byte[]%29)

getDate

Date getDate(String parameterName) throws SQLException

Retrieves the value of a JDBC DATE parameter as a java.sql.Date object.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setDate(java.lang.String, java.sql.Date)](../../java/sql/CallableStatement.html#setDate%28java.lang.String, java.sql.Date%29)

getTime

Time getTime(String parameterName) throws SQLException

Retrieves the value of a JDBC TIME parameter as a java.sql.Time object.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setTime(java.lang.String, java.sql.Time)](../../java/sql/CallableStatement.html#setTime%28java.lang.String, java.sql.Time%29)

getTimestamp

Timestamp getTimestamp(String parameterName) throws SQLException

Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setTimestamp(java.lang.String, java.sql.Timestamp)](../../java/sql/CallableStatement.html#setTimestamp%28java.lang.String, java.sql.Timestamp%29)

getObject

Object getObject(String parameterName) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

Returns:

A java.lang.Object holding the OUT parameter value.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

Types, [setObject(java.lang.String, java.lang.Object, int, int)](../../java/sql/CallableStatement.html#setObject%28java.lang.String, java.lang.Object, int, int%29)

getBigDecimal

BigDecimal getBigDecimal(String parameterName) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value in full precision. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setBigDecimal(java.lang.String, java.math.BigDecimal)](../../java/sql/CallableStatement.html#setBigDecimal%28java.lang.String, java.math.BigDecimal%29)

getObject

Object getObject(String parameterName, Map<String,Class<?>> map) throws SQLException

Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.

Parameters:

parameterName - the name of the parameter

map - the mapping from SQL type names to Java classes

Returns:

a java.lang.Object holding the OUT parameter value

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setObject(java.lang.String, java.lang.Object, int, int)](../../java/sql/CallableStatement.html#setObject%28java.lang.String, java.lang.Object, int, int%29)

getRef

Ref getRef(String parameterName) throws SQLException

Retrieves the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

getBlob

Blob getBlob(String parameterName) throws SQLException

Retrieves the value of a JDBC BLOB parameter as aBlob object in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

getClob

Clob getClob(String parameterName) throws SQLException

Retrieves the value of a JDBC CLOB parameter as aClob object in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

getArray

Array getArray(String parameterName) throws SQLException

Retrieves the value of a JDBC ARRAY parameter as anArray object in the Java programming language.

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value as an Array object in Java programming language. If the value was SQL NULL, the value null is returned.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

getDate

Date getDate(String parameterName, Calendar cal) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

cal - the Calendar object the driver will use to construct the date

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setDate(java.lang.String, java.sql.Date)](../../java/sql/CallableStatement.html#setDate%28java.lang.String, java.sql.Date%29)

getTime

Time getTime(String parameterName, Calendar cal) throws SQLException

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.

Parameters:

parameterName - the name of the parameter

cal - the Calendar object the driver will use to construct the time

Returns:

the parameter value; if the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setTime(java.lang.String, java.sql.Time)](../../java/sql/CallableStatement.html#setTime%28java.lang.String, java.sql.Time%29)

getTimestamp

Timestamp getTimestamp(String parameterName, Calendar cal) throws SQLException

Retrieves the value of a JDBC TIMESTAMP parameter as ajava.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.

Parameters:

parameterName - the name of the parameter

cal - the Calendar object the driver will use to construct the timestamp

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs

Since:

1.4

See Also:

[setTimestamp(java.lang.String, java.sql.Timestamp)](../../java/sql/CallableStatement.html#setTimestamp%28java.lang.String, java.sql.Timestamp%29)

getURL

URL getURL(String parameterName) throws SQLException

Retrieves the value of a JDBC DATALINK parameter as ajava.net.URL object.

Parameters:

parameterName - the name of the parameter

Returns:

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:

[SQLException](../../java/sql/SQLException.html "class in java.sql") - if a database access error occurs, or if there is a problem with the URL

Since:

1.4

See Also:

[setURL(java.lang.String, java.net.URL)](../../java/sql/CallableStatement.html#setURL%28java.lang.String, java.net.URL%29)

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.