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 ArraygetArray(int i) Gets the value of a JDBCARRAYparameter as an Array object in the Java programming language.Retrieves the value of a JDBCARRAYparameter as anArrayobject in the Java programming language.final BigDecimalgetBigDecimal(int parameterIndex) Gets the value of a JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.final BigDecimalgetBigDecimal(int parameterIndex, int scale) Deprecated.getBigDecimal(String parameterName) Retrieves the value of a JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.final BlobgetBlob(int i) Gets the value of a JDBCBLOBparameter as a Blob\ object in the Java programming language.Retrieves the value of a JDBCBLOBparameter as aBlobobject in the Java programming language.final booleangetBoolean(int parameterIndex) Gets the value of a JDBCBITparameter as abooleanin the Java programming language.booleangetBoolean(String parameterName) Retrieves the value of a JDBCBITparameter as abooleanin the Java programming language.final bytegetByte(int parameterIndex) Gets the value of a JDBCTINYINTparameter as abytein the Java programming language.byteRetrieves the value of a JDBCTINYINTparameter as abytein the Java programming language.final byte[]getBytes(int parameterIndex) Gets the value of a JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.byte[]Retrieves the value of a JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.getCharacterStream(int parameterIndex) getCharacterStream(String parameterName) final ClobgetClob(int i) Gets the value of a JDBCCLOBparameter as aClobobject in the Java programming language.Retrieves the value of a JDBCCLOBparameter as aClobobject in the Java programming language.final DategetDate(int parameterIndex) Gets the value of a JDBCDATEparameter as ajava.sql.Dateobject.final DateGets the value of a JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date.Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject.Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date.final doublegetDouble(int parameterIndex) Gets the value of a JDBCDOUBLEparameter as adoublein the Java programming language.doubleRetrieves the value of a JDBCDOUBLEparameter as adoublein the Java programming language.final floatgetFloat(int parameterIndex) Gets the value of a JDBCFLOATparameter as afloatin the Java programming language.floatRetrieves the value of a JDBCFLOATparameter as afloatin the Java programming language.final intgetInt(int parameterIndex) Gets the value of a JDBCINTEGERparameter as anintin the Java programming language.intRetrieves the value of a JDBCINTEGERparameter as anintin the Java programming language.final longgetLong(int parameterIndex) Gets the value of a JDBCBIGINTparameter as alongin the Java programming language.longRetrieves the value of a JDBCBIGINTparameter as alongin the Java programming language.getNCharacterStream(int parameterIndex) getNCharacterStream(String parameterName) getNClob(int parameterIndex) getNString(int parameterIndex) getNString(String parameterName) final ObjectgetObject(int parameterIndex) Gets the value of a parameter as anObjectin the Java programming language.<T> Tfinal ObjectReturns an object representing the value of OUT parameteriand usesmapfor the custom mapping of the parameter value.Retrieves the value of a parameter as anObjectin the Java programming language.<T> TReturns an object representing the value of OUT parameteriand usesmapfor the custom mapping of the parameter value.final RefgetRef(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 aRefobject in the Java programming language.getRowId(int parameterIndex) final shortgetShort(int parameterIndex) Gets the value of a JDBCSMALLINTparameter as ashortin the Java programming language.shortRetrieves the value of a JDBCSMALLINTparameter as ashortin the Java programming language.getSQLXML(int parameterIndex) final StringgetString(int parameterIndex) Retrieves the value of a JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.Retrieves the value of a JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.final TimegetTime(int parameterIndex) Get the value of a JDBCTIMEparameter as ajava.sql.Timeobject.final TimeGets the value of a JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time.Retrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject.Retrieves the value of a JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time.final TimestampgetTimestamp(int parameterIndex) Gets the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.final TimestampgetTimestamp(int parameterIndex, Calendar cal) Gets the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject.getTimestamp(String parameterName) Retrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.getTimestamp(String parameterName, Calendar cal) Retrieves the value of a JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject.getURL(int parameterIndex) Retrieves the value of the designated JDBCDATALINKparameter as ajava.net.URLobject.Retrieves the value of a JDBCDATALINKparameter as ajava.net.URLobject.final voidregisterOutParameter(int parameterIndex, int sqlType) Registers the OUT parameter in ordinal positionparameterIndexto the JDBC typesqlType.final voidregisterOutParameter(int parameterIndex, int sqlType, int scale) Registers the parameter in ordinal positionparameterIndexto be of JDBC typesqlType.final voidregisterOutParameter(int paramIndex, int sqlType, String typeName) Registers the designated output parameter.voidregisterOutParameter(String parameterName, int sqlType) Registers the OUT parameter namedparameterNameto the JDBC typesqlType.voidregisterOutParameter(String parameterName, int sqlType, int scale) Registers the parameter namedparameterNameto be of JDBC typesqlType.voidregisterOutParameter(String parameterName, int sqlType, String typeName) Registers the designated output parameter.voidsetAsciiStream(String parameterName, InputStream x) voidsetAsciiStream(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetAsciiStream(String parameterName, InputStream x, long length) voidsetBigDecimal(String parameterName, BigDecimal x) Sets the designated parameter to the givenjava.math.BigDecimalvalue.voidsetBinaryStream(String parameterName, InputStream x) voidsetBinaryStream(String parameterName, InputStream x, int length) Sets the designated parameter to the given input stream, which will have the specified number of bytes.voidsetBinaryStream(String parameterName, InputStream x, long length) voidsetBlob(String parameterName, InputStream inputStream) voidsetBlob(String parameterName, InputStream inputStream, long length) voidvoidsetBoolean(String parameterName, boolean x) Sets the designated parameter to the given Javabooleanvalue.voidSets the designated parameter to the given Javabytevalue.voidSets the designated parameter to the given Java array of bytes.voidsetCharacterStream(String parameterName, Reader reader) voidsetCharacterStream(String parameterName, Reader reader, int length) Sets the designated parameter to the givenReaderobject, which is the given number of characters long.voidsetCharacterStream(String parameterName, Reader reader, long length) voidvoidvoidvoidSets the designated parameter to the givenjava.sql.Datevalue.voidSets the designated parameter to the givenjava.sql.Datevalue, using the givenCalendarobject.voidSets the designated parameter to the given Javadoublevalue.voidSets the designated parameter to the given Javafloatvalue.voidSets the designated parameter to the given Javaintvalue.voidSets the designated parameter to the given Javalongvalue.voidsetNCharacterStream(String parameterName, Reader value) voidsetNCharacterStream(String parameterName, Reader value, long length) voidvoidvoidvoidsetNString(String parameterName, String value) voidSets the designated parameter to SQLNULL.voidSets the designated parameter to SQLNULL.voidSets the value of the designated parameter with the given object.voidSets the value of the designated parameter with the given object.voidSets the value of the designated parameter with the given object.voidvoidSets the designated parameter to the given Javashortvalue.voidvoidSets the designated parameter to the given JavaStringvalue.voidSets the designated parameter to the givenjava.sql.Timevalue.voidSets the designated parameter to the givenjava.sql.Timevalue, using the givenCalendarobject.voidsetTimestamp(String parameterName, Timestamp x) Sets the designated parameter to the givenjava.sql.Timestampvalue.voidsetTimestamp(String parameterName, Timestamp x, Calendar cal) Sets the designated parameter to the givenjava.sql.Timestampvalue, using the givenCalendarobject.voidSets the designated parameter to the givenjava.net.URLobject.final booleanwasNull()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, setURLMethods 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, wrapResultSetMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface java.sql.CallableStatement
registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, registerOutParameter, setObject, setObjectMethods 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, setURLMethods 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, setQueryTimeoutMethods 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, orLONGVARCHARparameter as aStringin the Java programming language.For the fixed-length type JDBC
CHAR, theStringobject returned has exactly the same value the JDBCCHARvalue had in the database, including any padding added by the database.- Specified by:
getStringin 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 JDBCBITparameter as abooleanin the Java programming language.- Specified by:
getBooleanin 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 JDBCTINYINTparameter as abytein the Java programming language.- Specified by:
getBytein 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 JDBCSMALLINTparameter as ashortin the Java programming language.- Specified by:
getShortin 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 JDBCINTEGERparameter as anintin the Java programming language.- Specified by:
getIntin 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 JDBCBIGINTparameter as alongin the Java programming language.- Specified by:
getLongin 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 JDBCFLOATparameter as afloatin the Java programming language.- Specified by:
getFloatin 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 JDBCDOUBLEparameter as adoublein the Java programming language.- Specified by:
getDoublein 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 JDBCNUMERICparameter as ajava.math.BigDecimalobject with scale digits to the right of the decimal point.- Specified by:
getBigDecimalin 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 JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.- Specified by:
getBytesin 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 JDBCDATEparameter as ajava.sql.Dateobject.- Specified by:
getDatein 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 JDBCTIMEparameter as ajava.sql.Timeobject.- Specified by:
getTimein 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 JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.- Specified by:
getTimestampin 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 anObjectin 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:
getObjectin interfaceCallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so on- Returns:
- A
java.lang.Objectholding the OUT parameter value. - Throws:
SQLException- if a database access error occurs
-
getBigDecimal
Gets the value of a JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.- Specified by:
getBigDecimalin 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 parameteriand usesmapfor 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:
getObjectin 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.Objectholding 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:
getRefin interfaceCallableStatement- Parameters:
i- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Refobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
getBlob
Gets the value of a JDBCBLOBparameter as a Blob\ object in the Java programming language.- Specified by:
getBlobin interfaceCallableStatement- Parameters:
i- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Blobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
getClob
Gets the value of a JDBCCLOBparameter as aClobobject in the Java programming language.- Specified by:
getClobin interfaceCallableStatement- Parameters:
i- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as a
Clobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
getArray
Gets the value of a JDBCARRAYparameter as an Array object in the Java programming language.- Specified by:
getArrayin interfaceCallableStatement- Parameters:
i- the first parameter is 1, the second is 2, and so on- Returns:
- the parameter value as an
Arrayobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if a database access error occurs- Since:
- 1.2
-
getDate
Gets the value of a JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date. With aCalendarobject, the driver can calculate the date taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Specified by:
getDatein interfaceCallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject 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 JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time. With aCalendarobject, the driver can calculate the time taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Specified by:
getTimein interfaceCallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject 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 JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Specified by:
getTimestampin interfaceCallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2, and so oncal- theCalendarobject 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 positionparameterIndexto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod 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,
sqlTypeshould bejava.sql.Types.OTHER. The method getObject retrieves the value.- Specified by:
registerOutParameterin 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 typeNUMERICorDECIMAL, the version ofregisterOutParameterthat 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 positionparameterIndexto be of JDBC typesqlType. This method must be called before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.This version of
registerOutParametershould be used when the parameter is of JDBC typeNUMERICorDECIMAL.- Specified by:
registerOutParameterin 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 agetXXXmethod; otherwise, there is no value to use in determining whether it isnullor not.- Specified by:
wasNullin interfaceCallableStatement- Returns:
trueif the last parameter read was SQLNULL;falseotherwise- 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 methodregisterOutParametershould 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 callregisterOutParameterto register the type fromjava.sql.Typesfor 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
getXXXmethod whose Java type XXX corresponds to the parameter's registered SQL type.- Specified by:
registerOutParameterin 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 JDBCDATALINKparameter as ajava.net.URLobject.- Specified by:
getURLin interfaceCallableStatement- Parameters:
parameterIndex- the first parameter is 1, the second is 2,...- Returns:
- a
java.net.URLobject that represents the JDBCDATALINKvalue 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.URLobject. The driver converts this to an SQLDATALINKvalue when it sends it to the database.- Specified by:
setURLin 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:
setNullin 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 Javabooleanvalue. The driver converts this to an SQLBITvalue when it sends it to the database.- Specified by:
setBooleanin 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 Javabytevalue. The driver converts this to an SQLTINYINTvalue when it sends it to the database.- Specified by:
setBytein 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 Javashortvalue. The driver converts this to an SQLSMALLINTvalue when it sends it to the database.- Specified by:
setShortin 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 Javaintvalue. The driver converts this to an SQLINTEGERvalue when it sends it to the database.- Specified by:
setIntin 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 Javalongvalue. The driver converts this to an SQLBIGINTvalue when it sends it to the database.- Specified by:
setLongin 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 Javafloatvalue. The driver converts this to an SQLFLOATvalue when it sends it to the database.- Specified by:
setFloatin 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 Javadoublevalue. The driver converts this to an SQLDOUBLEvalue when it sends it to the database.- Specified by:
setDoublein 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.BigDecimalvalue. The driver converts this to an SQLNUMERICvalue when it sends it to the database.- Specified by:
setBigDecimalin 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 JavaStringvalue. The driver converts this to an SQLVARCHARorLONGVARCHARvalue (depending on the argument's size relative to the driver's limits onVARCHARvalues) when it sends it to the database.- Specified by:
setStringin 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 SQLVARBINARYorLONGVARBINARY(depending on the argument's size relative to the driver's limits onVARBINARYvalues) when it sends it to the database.- Specified by:
setBytesin 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.Datevalue. The driver converts this to an SQLDATEvalue when it sends it to the database.- Specified by:
setDatein 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.Timevalue. The driver converts this to an SQLTIMEvalue when it sends it to the database.- Specified by:
setTimein 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.Timestampvalue. The driver converts this to an SQLTIMESTAMPvalue when it sends it to the database.- Specified by:
setTimestampin 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 aLONGVARCHARparameter, 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:
setAsciiStreamin 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 aLONGVARBINARYparameter, it may be more practical to send it via ajava.io.InputStreamobject. 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:
setBinaryStreamin 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.langequivalent 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.writeSQLto 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:
setObjectin 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 methodsetObjectabove, except that it assumes a scale of zero.- Specified by:
setObjectin 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.langequivalent objects should be used for built-in types.The JDBC specification specifies a standard mapping from Java
Objecttypes 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.writeSQLto 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:
setObjectin 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 givenObjectparameter is ambiguous- Since:
- 1.4
-
setCharacterStream
Sets the designated parameter to the givenReaderobject, which is the given number of characters long. When a very large UNICODE value is input to aLONGVARCHARparameter, it may be more practical to send it via ajava.io.Readerobject. 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:
setCharacterStreamin interfaceCallableStatement- Parameters:
parameterName- the name of the parameterreader- thejava.io.Readerobject 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.Datevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLDATEvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the date taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setDatein interfaceCallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject 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.Timevalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMEvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the time taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTimein interfaceCallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject 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.Timestampvalue, using the givenCalendarobject. The driver uses theCalendarobject to construct an SQLTIMESTAMPvalue, which the driver then sends to the database. With a aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone. If noCalendarobject is specified, the driver uses the default timezone, which is that of the virtual machine running the application.- Specified by:
setTimestampin interfaceCallableStatement- Parameters:
parameterName- the name of the parameterx- the parameter valuecal- theCalendarobject 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 methodsetNullshould 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:
setNullin interfaceCallableStatement- Parameters:
parameterName- the name of the parametersqlType- a value fromjava.sql.TypestypeName- the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQLREFvalue- Throws:
SQLException- if a database access error occurs- Since:
- 1.4
-
getString
Retrieves the value of a JDBCCHAR,VARCHAR, orLONGVARCHARparameter as aStringin the Java programming language.For the fixed-length type JDBC
CHAR, theStringobject returned has exactly the same value the JDBCCHARvalue had in the database, including any padding added by the database.- Specified by:
getStringin 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 JDBCBITparameter as abooleanin the Java programming language.- Specified by:
getBooleanin 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 JDBCTINYINTparameter as abytein the Java programming language.- Specified by:
getBytein 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 JDBCSMALLINTparameter as ashortin the Java programming language.- Specified by:
getShortin 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 JDBCINTEGERparameter as anintin the Java programming language.- Specified by:
getIntin 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 JDBCBIGINTparameter as alongin the Java programming language.- Specified by:
getLongin 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 JDBCFLOATparameter as afloatin the Java programming language.- Specified by:
getFloatin 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 JDBCDOUBLEparameter as adoublein the Java programming language.- Specified by:
getDoublein 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 JDBCBINARYorVARBINARYparameter as an array ofbytevalues in the Java programming language.- Specified by:
getBytesin 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 JDBCDATEparameter as ajava.sql.Dateobject.- Specified by:
getDatein 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 JDBCTIMEparameter as ajava.sql.Timeobject.- Specified by:
getTimein 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 JDBCTIMESTAMPparameter as ajava.sql.Timestampobject.- Specified by:
getTimestampin 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 anObjectin 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:
getObjectin interfaceCallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- A
java.lang.Objectholding the OUT parameter value. - Throws:
SQLException- if a database access error occurs- Since:
- 1.4
- See Also:
-
getBigDecimal
Retrieves the value of a JDBCNUMERICparameter as ajava.math.BigDecimalobject with as many digits to the right of the decimal point as the value contains.- Specified by:
getBigDecimalin 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 parameteriand usesmapfor 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:
getObjectin interfaceCallableStatement- Parameters:
parameterName- the name of the parametermap- the mapping from SQL type names to Java classes- Returns:
- a
java.lang.Objectholding 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 aRefobject in the Java programming language.- Specified by:
getRefin interfaceCallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
Refobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if a database access error occurs- Since:
- 1.4
-
getBlob
Retrieves the value of a JDBCBLOBparameter as aBlobobject in the Java programming language.- Specified by:
getBlobin interfaceCallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
Blobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if a database access error occurs- Since:
- 1.4
-
getClob
Retrieves the value of a JDBCCLOBparameter as aClobobject in the Java programming language.- Specified by:
getClobin interfaceCallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
Clobobject in the Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if a database access error occurs- Since:
- 1.4
-
getArray
Retrieves the value of a JDBCARRAYparameter as anArrayobject in the Java programming language.- Specified by:
getArrayin interfaceCallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as an
Arrayobject in Java programming language. If the value was SQLNULL, the valuenullis returned. - Throws:
SQLException- if a database access error occurs- Since:
- 1.4
-
getDate
Retrieves the value of a JDBCDATEparameter as ajava.sql.Dateobject, using the givenCalendarobject to construct the date. With aCalendarobject, the driver can calculate the date taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Specified by:
getDatein interfaceCallableStatement- Parameters:
parameterName- the name of the parametercal- theCalendarobject 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 JDBCTIMEparameter as ajava.sql.Timeobject, using the givenCalendarobject to construct the time. With aCalendarobject, the driver can calculate the time taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Specified by:
getTimein interfaceCallableStatement- Parameters:
parameterName- the name of the parametercal- theCalendarobject 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 JDBCTIMESTAMPparameter as ajava.sql.Timestampobject, using the givenCalendarobject to construct theTimestampobject. With aCalendarobject, the driver can calculate the timestamp taking into account a custom timezone and locale. If noCalendarobject is specified, the driver uses the default timezone and locale.- Specified by:
getTimestampin interfaceCallableStatement- Parameters:
parameterName- the name of the parametercal- theCalendarobject 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 JDBCDATALINKparameter as ajava.net.URLobject.- Specified by:
getURLin interfaceCallableStatement- Parameters:
parameterName- the name of the parameter- Returns:
- the parameter value as a
java.net.URLobject in the Java programming language. If the value was SQLNULL, the valuenullis 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 namedparameterNameto the JDBC typesqlType. All OUT parameters must be registered before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod 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,
sqlTypeshould bejava.sql.Types.OTHER. The method getObject retrieves the value.- Specified by:
registerOutParameterin interfaceCallableStatement- Parameters:
parameterName- the name of the parametersqlType- the JDBC type code defined byjava.sql.Types. If the parameter is of JDBC typeNUMERICorDECIMAL, the version ofregisterOutParameterthat accepts a scale value should be used.- Throws:
SQLException- if a database access error occurs- Since:
- 1.4
- See Also:
-
registerOutParameter
Registers the parameter namedparameterNameto be of JDBC typesqlType. This method must be called before a stored procedure is executed.The JDBC type specified by
sqlTypefor an OUT parameter determines the Java type that must be used in thegetmethod to read the value of that parameter.This version of
registerOutParametershould be used when the parameter is of JDBC typeNUMERICorDECIMAL.- Specified by:
registerOutParameterin 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 methodregisterOutParametershould 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 callregisterOutParameterto register the type fromjava.sql.Typesfor 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
getXXXmethod whose Java type XXX corresponds to the parameter's registered SQL type.- Specified by:
registerOutParameterin interfaceCallableStatement- Parameters:
parameterName- the name of the parametersqlType- a value fromTypestypeName- 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:
getObjectin interfaceCallableStatement- Throws:
SQLException
-
getObject
- Specified by:
getObjectin interfaceCallableStatement- Throws:
SQLException
-
setNClob
- Specified by:
setNClobin interfaceCallableStatement- Throws:
SQLException
-
setBlob
- Specified by:
setBlobin interfaceCallableStatement- Throws:
SQLException
-
setClob
- Specified by:
setClobin interfaceCallableStatement- Throws:
SQLException
-
setNCharacterStream
- Specified by:
setNCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
setCharacterStream
- Specified by:
setCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
setBinaryStream
- Specified by:
setBinaryStreamin interfaceCallableStatement- Throws:
SQLException
-
setAsciiStream
- Specified by:
setAsciiStreamin interfaceCallableStatement- Throws:
SQLException
-
setCharacterStream
public void setCharacterStream(String parameterName, Reader reader, long length) throws SQLException - Specified by:
setCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
setBinaryStream
- Specified by:
setBinaryStreamin interfaceCallableStatement- Throws:
SQLException
-
setAsciiStream
- Specified by:
setAsciiStreamin interfaceCallableStatement- Throws:
SQLException
-
setClob
- Specified by:
setClobin interfaceCallableStatement- Throws:
SQLException
-
setBlob
- Specified by:
setBlobin interfaceCallableStatement- Throws:
SQLException
-
getCharacterStream
- Specified by:
getCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
getCharacterStream
- Specified by:
getCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
getNCharacterStream
- Specified by:
getNCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
getNCharacterStream
- Specified by:
getNCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
getNString
- Specified by:
getNStringin interfaceCallableStatement- Throws:
SQLException
-
getNString
- Specified by:
getNStringin interfaceCallableStatement- Throws:
SQLException
-
getSQLXML
- Specified by:
getSQLXMLin interfaceCallableStatement- Throws:
SQLException
-
getSQLXML
- Specified by:
getSQLXMLin interfaceCallableStatement- Throws:
SQLException
-
setSQLXML
- Specified by:
setSQLXMLin interfaceCallableStatement- Throws:
SQLException
-
getNClob
- Specified by:
getNClobin interfaceCallableStatement- Throws:
SQLException
-
getNClob
- Specified by:
getNClobin interfaceCallableStatement- Throws:
SQLException
-
setNClob
- Specified by:
setNClobin interfaceCallableStatement- Throws:
SQLException
-
setBlob
- Specified by:
setBlobin interfaceCallableStatement- Throws:
SQLException
-
setClob
- Specified by:
setClobin interfaceCallableStatement- Throws:
SQLException
-
setNClob
- Specified by:
setNClobin interfaceCallableStatement- Throws:
SQLException
-
setNCharacterStream
public void setNCharacterStream(String parameterName, Reader value, long length) throws SQLException - Specified by:
setNCharacterStreamin interfaceCallableStatement- Throws:
SQLException
-
setNString
- Specified by:
setNStringin interfaceCallableStatement- Throws:
SQLException
-
setRowId
- Specified by:
setRowIdin interfaceCallableStatement- Throws:
SQLException
-
getRowId
- Specified by:
getRowIdin interfaceCallableStatement- Throws:
SQLException
-
getRowId
- Specified by:
getRowIdin interfaceCallableStatement- Throws:
SQLException
-