Class CallableStatementWrapper
- All Implemented Interfaces:
AutoCloseable
,CallableStatement
,PreparedStatement
,Statement
,Wrapper
{?= call <procedure-name>[<arg1>,<arg2>, ...]} {call <procedure-name>[<arg1>,<arg2>, ...]}
IN parameter values are set using the set methods inherited from
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 ResultSet 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.
Methods that are new in the JDBC 2.0 API are marked "Since 1.2."
- Version:
- $Revision: 1.4 $
-
Field Summary
FieldsFields 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
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal Array
getArray
(int i) Gets the value of a JDBCARRAY
parameter as an Array object in the Java programming language.Retrieves the value of a JDBCARRAY
parameter as anArray
object in the Java programming language.final BigDecimal
getBigDecimal
(int parameterIndex) Gets the value of a JDBCNUMERIC
parameter as ajava.math.BigDecimal
object with as many digits to the right of the decimal point as the value contains.final BigDecimal
getBigDecimal
(int parameterIndex, int scale) Deprecated.getBigDecimal
(String parameterName) Retrieves the value of a JDBCNUMERIC
parameter as ajava.math.BigDecimal
object with as many digits to the right of the decimal point as the value contains.final Blob
getBlob
(int i) Gets the value of a JDBCBLOB
parameter as a Blob\ object in the Java programming language.Retrieves the value of a JDBCBLOB
parameter as aBlob
object in the Java programming language.final boolean
getBoolean
(int parameterIndex) Gets the value of a JDBCBIT
parameter as aboolean
in the Java programming language.boolean
getBoolean
(String parameterName) Retrieves the value of a JDBCBIT
parameter as aboolean
in the Java programming language.final byte
getByte
(int parameterIndex) Gets the value of a JDBCTINYINT
parameter as abyte
in the Java programming language.byte
Retrieves the value of a JDBCTINYINT
parameter as abyte
in the Java programming language.final byte[]
getBytes
(int parameterIndex) Gets the value of a JDBCBINARY
orVARBINARY
parameter as an array ofbyte
values in the Java programming language.byte[]
Retrieves the value of a JDBCBINARY
orVARBINARY
parameter as an array ofbyte
values in the Java programming language.getCharacterStream
(int parameterIndex) getCharacterStream
(String parameterName) final Clob
getClob
(int i) Gets the value of a JDBCCLOB
parameter as aClob
object in the Java programming language.Retrieves the value of a JDBCCLOB
parameter as aClob
object in the Java programming language.final Date
getDate
(int parameterIndex) Gets the value of a JDBCDATE
parameter as ajava.sql.Date
object.final Date
Gets the value of a JDBCDATE
parameter as ajava.sql.Date
object, using the givenCalendar
object to construct the date.Retrieves the value of a JDBCDATE
parameter as ajava.sql.Date
object.Retrieves the value of a JDBCDATE
parameter as ajava.sql.Date
object, using the givenCalendar
object to construct the date.final double
getDouble
(int parameterIndex) Gets the value of a JDBCDOUBLE
parameter as adouble
in the Java programming language.double
Retrieves the value of a JDBCDOUBLE
parameter as adouble
in the Java programming language.final float
getFloat
(int parameterIndex) Gets the value of a JDBCFLOAT
parameter as afloat
in the Java programming language.float
Retrieves the value of a JDBCFLOAT
parameter as afloat
in the Java programming language.final int
getInt
(int parameterIndex) Gets the value of a JDBCINTEGER
parameter as anint
in the Java programming language.int
Retrieves the value of a JDBCINTEGER
parameter as anint
in the Java programming language.final long
getLong
(int parameterIndex) Gets the value of a JDBCBIGINT
parameter as along
in the Java programming language.long
Retrieves the value of a JDBCBIGINT
parameter as along
in the Java programming language.getNCharacterStream
(int parameterIndex) getNCharacterStream
(String parameterName) getNClob
(int parameterIndex) getNString
(int parameterIndex) getNString
(String parameterName) final Object
getObject
(int parameterIndex) Gets the value of a parameter as anObject
in the Java programming language.<T> T
final Object
Returns an object representing the value of OUT parameteri
and usesmap
for the custom mapping of the parameter value.Retrieves the value of a parameter as anObject
in the Java programming language.<T> T
Returns an object representing the value of OUT parameteri
and usesmap
for the custom mapping of the parameter value.final Ref
getRef
(int i) Gets the value of a JDBCREF(<structured-type>)
parameter as a Ref object in the Java programming language.Retrieves the value of a JDBCREF(<structured-type>)
parameter as aRef
object in the Java programming language.getRowId
(int parameterIndex) final short
getShort
(int parameterIndex) Gets the value of a JDBCSMALLINT
parameter as ashort
in the Java programming language.short
Retrieves the value of a JDBCSMALLINT
parameter as ashort
in the Java programming language.getSQLXML
(int parameterIndex) final String
getString
(int parameterIndex) Retrieves the value of a JDBCCHAR
,VARCHAR
, orLONGVARCHAR
parameter as aString
in the Java programming language.Retrieves the value of a JDBCCHAR
,VARCHAR
, orLONGVARCHAR
parameter as aString
in the Java programming language.final Time
getTime
(int parameterIndex) Get the value of a JDBCTIME
parameter as ajava.sql.Time
object.final Time
Gets the value of a JDBCTIME
parameter as ajava.sql.Time
object, using the givenCalendar
object to construct the time.Retrieves the value of a JDBCTIME
parameter as ajava.sql.Time
object.Retrieves the value of a JDBCTIME
parameter as ajava.sql.Time
object, using the givenCalendar
object to construct the time.final Timestamp
getTimestamp
(int parameterIndex) Gets the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object.final Timestamp
getTimestamp
(int parameterIndex, Calendar cal) Gets the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object, using the givenCalendar
object to construct theTimestamp
object.getTimestamp
(String parameterName) Retrieves the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object.getTimestamp
(String parameterName, Calendar cal) Retrieves the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object, using the givenCalendar
object to construct theTimestamp
object.getURL
(int parameterIndex) Retrieves the value of the designated JDBCDATALINK
parameter as ajava.net.URL
object.Retrieves the value of a JDBCDATALINK
parameter as ajava.net.URL
object.final void
registerOutParameter
(int parameterIndex, int sqlType) Registers the OUT parameter in ordinal positionparameterIndex
to the JDBC typesqlType
.final void
registerOutParameter
(int parameterIndex, int sqlType, int scale) Registers the parameter in ordinal positionparameterIndex
to be of JDBC typesqlType
.final void
registerOutParameter
(int paramIndex, int sqlType, String typeName) Registers the designated output parameter.void
registerOutParameter
(String parameterName, int sqlType) Registers the OUT parameter namedparameterName
to the JDBC typesqlType
.void
registerOutParameter
(String parameterName, int sqlType, int scale) Registers the parameter namedparameterName
to be of JDBC typesqlType
.void
registerOutParameter
(String parameterName, int sqlType, String typeName) Registers the designated output parameter.void
setAsciiStream
(String parameterName, InputStream x) void
setAsciiStream
(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setAsciiStream
(String parameterName, InputStream x, long length) void
setBigDecimal
(String parameterName, BigDecimal x) Sets the designated parameter to the givenjava.math.BigDecimal
value.void
setBinaryStream
(String parameterName, InputStream x) void
setBinaryStream
(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.void
setBinaryStream
(String parameterName, InputStream x, long length) void
setBlob
(String parameterName, InputStream inputStream) void
setBlob
(String parameterName, InputStream inputStream, long length) void
void
setBoolean
(String parameterName, boolean x) Sets the designated parameter to the given Javaboolean
value.void
Sets the designated parameter to the given Javabyte
value.void
Sets the designated parameter to the given Java array of bytes.void
setCharacterStream
(String parameterName, Reader reader) void
setCharacterStream
(String parameterName, Reader reader, int length) Sets the designated parameter to the givenReader
object, which is the given number of characters long.void
setCharacterStream
(String parameterName, Reader reader, long length) void
void
void
void
Sets the designated parameter to the givenjava.sql.Date
value.void
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object.void
Sets the designated parameter to the given Javadouble
value.void
Sets the designated parameter to the given Javafloat
value.void
Sets the designated parameter to the given Javaint
value.void
Sets the designated parameter to the given Javalong
value.void
setNCharacterStream
(String parameterName, Reader value) void
setNCharacterStream
(String parameterName, Reader value, long length) void
void
void
void
setNString
(String parameterName, String value) void
Sets the designated parameter to SQLNULL
.void
Sets the designated parameter to SQLNULL
.void
Sets the value of the designated parameter with the given object.void
Sets the value of the designated parameter with the given object.void
Sets the value of the designated parameter with the given object.void
void
Sets the designated parameter to the given Javashort
value.void
void
Sets the designated parameter to the given JavaString
value.void
Sets the designated parameter to the givenjava.sql.Time
value.void
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object.void
setTimestamp
(String parameterName, Timestamp x) Sets the designated parameter to the givenjava.sql.Timestamp
value.void
setTimestamp
(String parameterName, Timestamp x, Calendar cal) Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object.void
Sets the designated parameter to the givenjava.net.URL
object.final boolean
wasNull()
Indicates whether or not the last OUT parameter read had the value of SQLNULL
.Methods inherited from class com.gargoylesoftware.base.resource.jdbc.PreparedStatementWrapper
addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL
Methods inherited from class com.gargoylesoftware.base.resource.jdbc.StatementWrapper
addBatch, cancel, checkIsOpen, clearBatch, clearWarnings, close, closeOnCompletion, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getDelegate, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isWrapperFor, setConnection, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout, unwrap, wrapResultSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.sql.CallableStatement
registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setObject, setObject
Methods inherited from interface java.sql.PreparedStatement
addBatch, clearParameters, execute, executeLargeUpdate, executeQuery, executeUpdate, getMetaData, getParameterMetaData, setArray, setAsciiStream, setAsciiStream, setAsciiStream, setBigDecimal, setBinaryStream, setBinaryStream, setBinaryStream, setBlob, setBlob, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setCharacterStream, setCharacterStream, setClob, setClob, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNCharacterStream, setNCharacterStream, setNClob, setNClob, setNClob, setNString, setNull, setNull, setObject, setObject, setObject, setObject, setObject, setRef, setRowId, setShort, setSQLXML, setString, setTime, setTime, setTimestamp, setTimestamp, setUnicodeStream, setURL
Methods inherited from interface java.sql.Statement
addBatch, cancel, clearBatch, clearWarnings, close, closeOnCompletion, enquoteIdentifier, enquoteLiteral, enquoteNCharLiteral, execute, execute, execute, execute, executeBatch, executeLargeBatch, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeLargeUpdate, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getLargeMaxRows, getLargeUpdateCount, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, isClosed, isCloseOnCompletion, isPoolable, isSimpleIdentifier, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setLargeMaxRows, setMaxFieldSize, setMaxRows, setPoolable, setQueryTimeout
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
-
Field Details
-
delegate_
-
-
Constructor Details
-
CallableStatementWrapper
Create a wrapper- Parameters:
statement
- The statement that is being wrapped
-
-
Method Details
-
getString
Retrieves the value of a JDBCCHAR
,VARCHAR
, orLONGVARCHAR
parameter as aString
in the Java programming language.For the fixed-length type JDBC
CHAR
, theString
object returned has exactly the same value the JDBCCHAR
value had in the database, including any padding added by the database.- Specified by:
getString
in interfaceCallableStatement
- 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 isnull
. - Throws:
SQLException
- if a database access error occurs
-
getBoolean
Gets the value of a JDBCBIT
parameter as aboolean
in the Java programming language.- Specified by:
getBoolean
in interfaceCallableStatement
- 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 isfalse
. - Throws:
SQLException
- if a database access error occurs
-
getByte
Gets the value of a JDBCTINYINT
parameter as abyte
in the Java programming language.- Specified by:
getByte
in interfaceCallableStatement
- 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
- if a database access error occurs
-
getShort
Gets the value of a JDBCSMALLINT
parameter as ashort
in the Java programming language.- Specified by:
getShort
in interfaceCallableStatement
- 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
- if a database access error occurs
-
getInt
Gets the value of a JDBCINTEGER
parameter as anint
in the Java programming language.- Specified by:
getInt
in interfaceCallableStatement
- 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
- if a database access error occurs
-
getLong
Gets the value of a JDBCBIGINT
parameter as along
in the Java programming language.- Specified by:
getLong
in interfaceCallableStatement
- 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
- if a database access error occurs
-
getFloat
Gets the value of a JDBCFLOAT
parameter as afloat
in the Java programming language.- Specified by:
getFloat
in interfaceCallableStatement
- 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
- if a database access error occurs
-
getDouble
Gets the value of a JDBCDOUBLE
parameter as adouble
in the Java programming language.- Specified by:
getDouble
in interfaceCallableStatement
- 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
- if a database access error occurs
-
getBigDecimal
Deprecated.Gets the value of a JDBCNUMERIC
parameter as ajava.math.BigDecimal
object with scale digits to the right of the decimal point.- Specified by:
getBigDecimal
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so onscale
- the number of digits to the right of the decimal point- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs
-
getBytes
Gets the value of a JDBCBINARY
orVARBINARY
parameter as an array ofbyte
values in the Java programming language.- Specified by:
getBytes
in interfaceCallableStatement
- 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 isnull
. - Throws:
SQLException
- if a database access error occurs
-
getDate
Gets the value of a JDBCDATE
parameter as ajava.sql.Date
object.- Specified by:
getDate
in interfaceCallableStatement
- 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 isnull
. - Throws:
SQLException
- if a database access error occurs
-
getTime
Get the value of a JDBCTIME
parameter as ajava.sql.Time
object.- Specified by:
getTime
in interfaceCallableStatement
- 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 isnull
. - Throws:
SQLException
- if a database access error occurs
-
getTimestamp
Gets the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object.- Specified by:
getTimestamp
in interfaceCallableStatement
- 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 isnull
. - Throws:
SQLException
- if a database access error occurs
-
getObject
Gets the value of a parameter as anObject
in the Java programming language.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 asjava.sql.Types.OTHER
, this method can be used to read database-specific abstract data types.- Specified by:
getObject
in interfaceCallableStatement
- 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
- if a database access error occurs
-
getBigDecimal
Gets the value of a JDBCNUMERIC
parameter as ajava.math.BigDecimal
object with as many digits to the right of the decimal point as the value contains.- Specified by:
getBigDecimal
in interfaceCallableStatement
- 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 isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getObject
Returns an object representing the value of OUT parameteri
and usesmap
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 asjava.sql.Types.OTHER
, this method can be used to read database-specific abstract data types.- Specified by:
getObject
in interfaceCallableStatement
- Parameters:
i
- the first parameter is 1, the second is 2, and so onmap
- the mapping from SQL type names to Java classes- Returns:
- a
java.lang.Object
holding the OUT parameter value - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getRef
Gets the value of a JDBCREF(<structured-type>)
parameter as a Ref object in the Java programming language.- Specified by:
getRef
in interfaceCallableStatement
- 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 SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getBlob
Gets the value of a JDBCBLOB
parameter as a Blob\ object in the Java programming language.- Specified by:
getBlob
in interfaceCallableStatement
- 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 SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getClob
Gets the value of a JDBCCLOB
parameter as aClob
object in the Java programming language.- Specified by:
getClob
in interfaceCallableStatement
- 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 SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getArray
Gets the value of a JDBCARRAY
parameter as an Array object in the Java programming language.- Specified by:
getArray
in interfaceCallableStatement
- 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 SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getDate
Gets the value of a JDBCDATE
parameter as ajava.sql.Date
object, using the givenCalendar
object to construct the date. With aCalendar
object, the driver can calculate the date taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getDate
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so oncal
- theCalendar
object the driver will use to construct the date- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs
-
getTime
Gets the value of a JDBCTIME
parameter as ajava.sql.Time
object, using the givenCalendar
object to construct the time. With aCalendar
object, the driver can calculate the time taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getTime
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so oncal
- theCalendar
object the driver will use to construct the time- Returns:
- the parameter value; if the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs
-
getTimestamp
Gets the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object, using the givenCalendar
object to construct theTimestamp
object. With aCalendar
object, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getTimestamp
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so oncal
- theCalendar
object the driver will use to construct the timestamp- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs
-
registerOutParameter
Registers the OUT parameter in ordinal positionparameterIndex
to the JDBC typesqlType
. 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 theget
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 bejava.sql.Types.OTHER
. The method getObject retrieves the value.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so onsqlType
- the JDBC type code defined byjava.sql.Types
. If the parameter is of JDBC typeNUMERIC
orDECIMAL
, the version ofregisterOutParameter
that accepts a scale value should be used.- Throws:
SQLException
- if a database access error occurs
-
registerOutParameter
public final 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 theget
method to read the value of that parameter.This version of
registerOutParameter
should be used when the parameter is of JDBC typeNUMERIC
orDECIMAL
.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2, and so onsqlType
- SQL type code defined byjava.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
- if a database access error occurs
-
wasNull
Indicates whether or not the last OUT parameter read had the value of SQLNULL
. Note that this method should be called only after calling agetXXX
method; otherwise, there is no value to use in determining whether it isnull
or not.- Specified by:
wasNull
in interfaceCallableStatement
- Returns:
true
if the last parameter read was SQLNULL
;false
otherwise- Throws:
SQLException
- if a database access error occurs
-
registerOutParameter
public final void registerOutParameter(int paramIndex, int sqlType, String typeName) throws SQLException Registers the designated output parameter. This version of the methodregisterOutParameter
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 callregisterOutParameter
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.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
paramIndex
- the first parameter is 1, the second is 2,...sqlType
- a value from java.sql.TypestypeName
- the fully-qualified name of an SQL structured type- Throws:
SQLException
- if a database access error occurs- Since:
- 1.2
-
getURL
Retrieves the value of the designated JDBCDATALINK
parameter as ajava.net.URL
object.- Specified by:
getURL
in interfaceCallableStatement
- Parameters:
parameterIndex
- the first parameter is 1, the second is 2,...- Returns:
- a
java.net.URL
object that represents the JDBCDATALINK
value used as the designated parameter - Throws:
SQLException
- 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
Sets the designated parameter to the givenjava.net.URL
object. The driver converts this to an SQLDATALINK
value when it sends it to the database.- Specified by:
setURL
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterval
- the parameter value- Throws:
SQLException
- if a database access error occurs, or if a URL is malformed- Since:
- 1.4
-
setNull
Sets the designated parameter to SQLNULL
.Note: You must specify the parameter's SQL type.
- Specified by:
setNull
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametersqlType
- the SQL type code defined injava.sql.Types
- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setBoolean
Sets the designated parameter to the given Javaboolean
value. The driver converts this to an SQLBIT
value when it sends it to the database.- Specified by:
setBoolean
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setByte
Sets the designated parameter to the given Javabyte
value. The driver converts this to an SQLTINYINT
value when it sends it to the database.- Specified by:
setByte
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setShort
Sets the designated parameter to the given Javashort
value. The driver converts this to an SQLSMALLINT
value when it sends it to the database.- Specified by:
setShort
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setInt
Sets the designated parameter to the given Javaint
value. The driver converts this to an SQLINTEGER
value when it sends it to the database.- Specified by:
setInt
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setLong
Sets the designated parameter to the given Javalong
value. The driver converts this to an SQLBIGINT
value when it sends it to the database.- Specified by:
setLong
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setFloat
Sets the designated parameter to the given Javafloat
value. The driver converts this to an SQLFLOAT
value when it sends it to the database.- Specified by:
setFloat
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setDouble
Sets the designated parameter to the given Javadouble
value. The driver converts this to an SQLDOUBLE
value when it sends it to the database.- Specified by:
setDouble
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setBigDecimal
Sets the designated parameter to the givenjava.math.BigDecimal
value. The driver converts this to an SQLNUMERIC
value when it sends it to the database.- Specified by:
setBigDecimal
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setString
Sets the designated parameter to the given JavaString
value. The driver converts this to an SQLVARCHAR
orLONGVARCHAR
value (depending on the argument's size relative to the driver's limits onVARCHAR
values) when it sends it to the database.- Specified by:
setString
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setBytes
Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQLVARBINARY
orLONGVARBINARY
(depending on the argument's size relative to the driver's limits onVARBINARY
values) when it sends it to the database.- Specified by:
setBytes
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setDate
Sets the designated parameter to the givenjava.sql.Date
value. The driver converts this to an SQLDATE
value when it sends it to the database.- Specified by:
setDate
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setTime
Sets the designated parameter to the givenjava.sql.Time
value. The driver converts this to an SQLTIME
value when it sends it to the database.- Specified by:
setTime
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestamp
value. The driver converts this to an SQLTIMESTAMP
value when it sends it to the database.- Specified by:
setTimestamp
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setAsciiStream
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 aLONGVARCHAR
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.
- Specified by:
setAsciiStream
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the Java input stream that contains the ASCII parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setBinaryStream
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 aLONGVARBINARY
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.
- Specified by:
setBinaryStream
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the java input stream which contains the binary parameter valuelength
- the number of bytes in the stream- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setObject
public 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 methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,Struct
, orArray
, 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.
- Specified by:
setObject
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the object containing the input parameter valuetargetSqlType
- 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
- if a database access error occurs- Since:
- 1.4
- See Also:
-
setObject
Sets the value of the designated parameter with the given object. This method is like the methodsetObject
above, except that it assumes a scale of zero.- Specified by:
setObject
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the object containing the input parameter valuetargetSqlType
- the SQL type (as defined in java.sql.Types) to be sent to the database- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setObject
Sets the value of the designated parameter with the given object. The second parameter must be of typeObject
; 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 methodSQLData.writeSQL
to write it to the SQL data stream. If, on the other hand, the object is of a class implementingRef
,Blob
,Clob
,Struct
, orArray
, 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.
- Specified by:
setObject
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the object containing the input parameter value- Throws:
SQLException
- if a database access error occurs or if the givenObject
parameter is ambiguous- Since:
- 1.4
-
setCharacterStream
Sets the designated parameter to the givenReader
object, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHAR
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.
- Specified by:
setCharacterStream
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterreader
- thejava.io.Reader
object that contains the UNICODE data used as the designated parameterlength
- the number of characters in the stream- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setDate
Sets the designated parameter to the givenjava.sql.Date
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLDATE
value, which the driver then sends to the database. With a aCalendar
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.- Specified by:
setDate
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter valuecal
- theCalendar
object the driver will use to construct the date- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setTime
Sets the designated parameter to the givenjava.sql.Time
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIME
value, which the driver then sends to the database. With a aCalendar
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.- Specified by:
setTime
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter valuecal
- theCalendar
object the driver will use to construct the time- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setTimestamp
Sets the designated parameter to the givenjava.sql.Timestamp
value, using the givenCalendar
object. The driver uses theCalendar
object to construct an SQLTIMESTAMP
value, which the driver then sends to the database. With a aCalendar
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.- Specified by:
setTimestamp
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameterx
- the parameter valuecal
- theCalendar
object the driver will use to construct the timestamp- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
setNull
Sets the designated parameter to SQLNULL
. This version of the methodsetNull
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.
- Specified by:
setNull
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametersqlType
- a value fromjava.sql.Types
typeName
- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQLREF
value- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getString
Retrieves the value of a JDBCCHAR
,VARCHAR
, orLONGVARCHAR
parameter as aString
in the Java programming language.For the fixed-length type JDBC
CHAR
, theString
object returned has exactly the same value the JDBCCHAR
value had in the database, including any padding added by the database.- Specified by:
getString
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getBoolean
Retrieves the value of a JDBCBIT
parameter as aboolean
in the Java programming language.- Specified by:
getBoolean
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isfalse
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getByte
Retrieves the value of a JDBCTINYINT
parameter as abyte
in the Java programming language.- Specified by:
getByte
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getShort
Retrieves the value of a JDBCSMALLINT
parameter as ashort
in the Java programming language.- Specified by:
getShort
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getInt
Retrieves the value of a JDBCINTEGER
parameter as anint
in the Java programming language.- Specified by:
getInt
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getLong
Retrieves the value of a JDBCBIGINT
parameter as along
in the Java programming language.- Specified by:
getLong
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getFloat
Retrieves the value of a JDBCFLOAT
parameter as afloat
in the Java programming language.- Specified by:
getFloat
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getDouble
Retrieves the value of a JDBCDOUBLE
parameter as adouble
in the Java programming language.- Specified by:
getDouble
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result is0
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getBytes
Retrieves the value of a JDBCBINARY
orVARBINARY
parameter as an array ofbyte
values in the Java programming language.- Specified by:
getBytes
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getDate
Retrieves the value of a JDBCDATE
parameter as ajava.sql.Date
object.- Specified by:
getDate
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getTime
Retrieves the value of a JDBCTIME
parameter as ajava.sql.Time
object.- Specified by:
getTime
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getTimestamp
Retrieves the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object.- Specified by:
getTimestamp
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getObject
Retrieves the value of a parameter as anObject
in the Java programming language. If the value is an SQLNULL
, the driver returns a Javanull
.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 asjava.sql.Types.OTHER
, this method can be used to read database-specific abstract data types.- Specified by:
getObject
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- A
java.lang.Object
holding the OUT parameter value. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getBigDecimal
Retrieves the value of a JDBCNUMERIC
parameter as ajava.math.BigDecimal
object with as many digits to the right of the decimal point as the value contains.- Specified by:
getBigDecimal
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value in full precision. If the value is
SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getObject
Returns an object representing the value of OUT parameteri
and usesmap
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 asjava.sql.Types.OTHER
, this method can be used to read database-specific abstract data types.- Specified by:
getObject
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametermap
- the mapping from SQL type names to Java classes- Returns:
- a
java.lang.Object
holding the OUT parameter value - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getRef
Retrieves the value of a JDBCREF(<structured-type>)
parameter as aRef
object in the Java programming language.- Specified by:
getRef
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value as a
Ref
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getBlob
Retrieves the value of a JDBCBLOB
parameter as aBlob
object in the Java programming language.- Specified by:
getBlob
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value as a
Blob
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getClob
Retrieves the value of a JDBCCLOB
parameter as aClob
object in the Java programming language.- Specified by:
getClob
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value as a
Clob
object in the Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getArray
Retrieves the value of a JDBCARRAY
parameter as anArray
object in the Java programming language.- Specified by:
getArray
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parameter- Returns:
- the parameter value as an
Array
object in Java programming language. If the value was SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getDate
Retrieves the value of a JDBCDATE
parameter as ajava.sql.Date
object, using the givenCalendar
object to construct the date. With aCalendar
object, the driver can calculate the date taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getDate
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametercal
- theCalendar
object the driver will use to construct the date- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getTime
Retrieves the value of a JDBCTIME
parameter as ajava.sql.Time
object, using the givenCalendar
object to construct the time. With aCalendar
object, the driver can calculate the time taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getTime
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametercal
- theCalendar
object the driver will use to construct the time- Returns:
- the parameter value; if the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getTimestamp
Retrieves the value of a JDBCTIMESTAMP
parameter as ajava.sql.Timestamp
object, using the givenCalendar
object to construct theTimestamp
object. With aCalendar
object, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendar
object is specified, the driver uses the default timezone and locale.- Specified by:
getTimestamp
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametercal
- theCalendar
object the driver will use to construct the timestamp- Returns:
- the parameter value. If the value is SQL
NULL
, the result isnull
. - Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
-
getURL
Retrieves the value of a JDBCDATALINK
parameter as ajava.net.URL
object.- Specified by:
getURL
in interfaceCallableStatement
- 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 SQLNULL
, the valuenull
is returned. - Throws:
SQLException
- if a database access error occurs, or if there is a problem with the URL- Since:
- 1.4
- See Also:
-
registerOutParameter
Registers the OUT parameter namedparameterName
to the JDBC typesqlType
. 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 theget
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 bejava.sql.Types.OTHER
. The method getObject retrieves the value.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametersqlType
- the JDBC type code defined byjava.sql.Types
. If the parameter is of JDBC typeNUMERIC
orDECIMAL
, the version ofregisterOutParameter
that accepts a scale value should be used.- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
registerOutParameter
Registers the parameter namedparameterName
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 theget
method to read the value of that parameter.This version of
registerOutParameter
should be used when the parameter is of JDBC typeNUMERIC
orDECIMAL
.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametersqlType
- SQL type code defined byjava.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
- if a database access error occurs- Since:
- 1.4
- See Also:
-
registerOutParameter
public void registerOutParameter(String parameterName, int sqlType, String typeName) throws SQLException Registers the designated output parameter. This version of the methodregisterOutParameter
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 callregisterOutParameter
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.- Specified by:
registerOutParameter
in interfaceCallableStatement
- Parameters:
parameterName
- the name of the parametersqlType
- a value fromTypes
typeName
- the fully-qualified name of an SQL structured type- Throws:
SQLException
- if a database access error occurs- Since:
- 1.4
- See Also:
-
getObject
- Specified by:
getObject
in interfaceCallableStatement
- Throws:
SQLException
-
getObject
- Specified by:
getObject
in interfaceCallableStatement
- Throws:
SQLException
-
setNClob
- Specified by:
setNClob
in interfaceCallableStatement
- Throws:
SQLException
-
setBlob
- Specified by:
setBlob
in interfaceCallableStatement
- Throws:
SQLException
-
setClob
- Specified by:
setClob
in interfaceCallableStatement
- Throws:
SQLException
-
setNCharacterStream
- Specified by:
setNCharacterStream
in interfaceCallableStatement
- Throws:
SQLException
-
setCharacterStream
- Specified by:
setCharacterStream
in interfaceCallableStatement
- Throws:
SQLException
-
setBinaryStream
- Specified by:
setBinaryStream
in interfaceCallableStatement
- Throws:
SQLException
-
setAsciiStream
- Specified by:
setAsciiStream
in interfaceCallableStatement
- Throws:
SQLException
-
setCharacterStream
public void setCharacterStream(String parameterName, Reader reader, long length) throws SQLException - Specified by:
setCharacterStream
in interfaceCallableStatement
- Throws:
SQLException
-
setBinaryStream
- Specified by:
setBinaryStream
in interfaceCallableStatement
- Throws:
SQLException
-
setAsciiStream
- Specified by:
setAsciiStream
in interfaceCallableStatement
- Throws:
SQLException
-
setClob
- Specified by:
setClob
in interfaceCallableStatement
- Throws:
SQLException
-
setBlob
- Specified by:
setBlob
in interfaceCallableStatement
- Throws:
SQLException
-
getCharacterStream
- Specified by:
getCharacterStream
in interfaceCallableStatement
- Throws:
SQLException
-
getCharacterStream
- Specified by:
getCharacterStream
in interfaceCallableStatement
- Throws:
SQLException
-
getNCharacterStream
- Specified by:
getNCharacterStream
in interfaceCallableStatement
- Throws:
SQLException
-
getNCharacterStream
- Specified by:
getNCharacterStream
in interfaceCallableStatement
- Throws:
SQLException
-
getNString
- Specified by:
getNString
in interfaceCallableStatement
- Throws:
SQLException
-
getNString
- Specified by:
getNString
in interfaceCallableStatement
- Throws:
SQLException
-
getSQLXML
- Specified by:
getSQLXML
in interfaceCallableStatement
- Throws:
SQLException
-
getSQLXML
- Specified by:
getSQLXML
in interfaceCallableStatement
- Throws:
SQLException
-
setSQLXML
- Specified by:
setSQLXML
in interfaceCallableStatement
- Throws:
SQLException
-
getNClob
- Specified by:
getNClob
in interfaceCallableStatement
- Throws:
SQLException
-
getNClob
- Specified by:
getNClob
in interfaceCallableStatement
- Throws:
SQLException
-
setNClob
- Specified by:
setNClob
in interfaceCallableStatement
- Throws:
SQLException
-
setBlob
- Specified by:
setBlob
in interfaceCallableStatement
- Throws:
SQLException
-
setClob
- Specified by:
setClob
in interfaceCallableStatement
- Throws:
SQLException
-
setNClob
- Specified by:
setNClob
in interfaceCallableStatement
- Throws:
SQLException
-
setNCharacterStream
public void setNCharacterStream(String parameterName, Reader value, long length) throws SQLException - Specified by:
setNCharacterStream
in interfaceCallableStatement
- Throws:
SQLException
-
setNString
- Specified by:
setNString
in interfaceCallableStatement
- Throws:
SQLException
-
setRowId
- Specified by:
setRowId
in interfaceCallableStatement
- Throws:
SQLException
-
getRowId
- Specified by:
getRowId
in interfaceCallableStatement
- Throws:
SQLException
-
getRowId
- Specified by:
getRowId
in interfaceCallableStatement
- Throws:
SQLException
-