|
|
Java example source code file (CallableStatement.java)
This example Java source code file (CallableStatement.java) is included in the alvinalexander.com
"Java Source Code
Warehouse" project. The intent of this project is to help you "Learn
Java by Example" TM.
Learn more about this Java project at its project page.
The CallableStatement.java Java example source code
/*
* Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package java.sql;
import java.math.BigDecimal;
import java.util.Calendar;
import java.io.Reader;
import java.io.InputStream;
/**
* The interface used to execute SQL stored procedures. The JDBC API
* provides a stored procedure SQL escape syntax that allows stored procedures
* to be called in a standard way for all RDBMSs. This escape syntax has one
* form that includes a result parameter and one that does not. If used, the result
* parameter must be registered as an OUT parameter. The other parameters
* can be used for input, output or both. Parameters are referred to
* sequentially, by number, with the first parameter being 1.
* <PRE>
* {?= call <procedure-name>[(<arg1>,<arg2>, ...)]}
* {call <procedure-name>[(<arg1>,<arg2>, ...)]}
* </PRE>
* <P>
* IN parameter values are set using the <code>set methods inherited from
* {@link PreparedStatement}. The type of all OUT parameters must be
* registered prior to executing the stored procedure; their values
* are retrieved after execution via the <code>get methods provided here.
* <P>
* A <code>CallableStatement can return one {@link ResultSet} object or
* multiple <code>ResultSet objects. Multiple
* <code>ResultSet objects are handled using operations
* inherited from {@link Statement}.
* <P>
* For maximum portability, a call's <code>ResultSet objects and
* update counts should be processed prior to getting the values of output
* parameters.
*
*
* @see Connection#prepareCall
* @see ResultSet
*/
public interface CallableStatement extends PreparedStatement {
/**
* Registers the OUT parameter in ordinal position
* <code>parameterIndex to the JDBC type
* <code>sqlType. All OUT parameters must be registered
* before a stored procedure is executed.
* <p>
* The JDBC type specified by <code>sqlType for an OUT
* parameter determines the Java type that must be used
* in the <code>get method to read the value of that parameter.
* <p>
* If the JDBC type expected to be returned to this output parameter
* is specific to this particular database, <code>sqlType
* should be <code>java.sql.Types.OTHER. The method
* {@link #getObject} retrieves the value.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param sqlType the JDBC type code defined by <code>java.sql.Types.
* If the parameter is of JDBC type <code>NUMERIC
* or <code>DECIMAL, the version of
* <code>registerOutParameter that accepts a scale value
* should be used.
*
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if <code>sqlType is
* a <code>ARRAY, BLOB, CLOB,
* <code>DATALINK, JAVA_OBJECT, NCHAR,
* <code>NCLOB, NVARCHAR, LONGNVARCHAR,
* <code>REF, ROWID, SQLXML
* or <code>STRUCT data type and the JDBC driver does not support
* this data type
* @see Types
*/
void registerOutParameter(int parameterIndex, int sqlType)
throws SQLException;
/**
* Registers the parameter in ordinal position
* <code>parameterIndex to be of JDBC type
* <code>sqlType. All OUT parameters must be registered
* before a stored procedure is executed.
* <p>
* The JDBC type specified by <code>sqlType for an OUT
* parameter determines the Java type that must be used
* in the <code>get method to read the value of that parameter.
* <p>
* This version of <code>registerOutParameter should be
* used when the parameter is of JDBC type <code>NUMERIC
* or <code>DECIMAL.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param sqlType the SQL type code defined by <code>java.sql.Types.
* @param scale the desired number of digits to the right of the
* decimal point. It must be greater than or equal to zero.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if <code>sqlType is
* a <code>ARRAY, BLOB, CLOB,
* <code>DATALINK, JAVA_OBJECT, NCHAR,
* <code>NCLOB, NVARCHAR, LONGNVARCHAR,
* <code>REF, ROWID, SQLXML
* or <code>STRUCT data type and the JDBC driver does not support
* this data type
* @see Types
*/
void registerOutParameter(int parameterIndex, int sqlType, int scale)
throws SQLException;
/**
* Retrieves whether the last OUT parameter read had the value of
* SQL <code>NULL. Note that this method should be called only after
* calling a getter method; otherwise, there is no value to use in
* determining whether it is <code>null or not.
*
* @return <code>true if the last parameter read was SQL
* <code>NULL; false otherwise
* @exception SQLException if a database access error occurs or
* this method is called on a closed <code>CallableStatement
*/
boolean wasNull() throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>CHAR,
* <code>VARCHAR, or LONGVARCHAR parameter as a
* <code>String in the Java programming language.
* <p>
* For the fixed-length type JDBC <code>CHAR,
* the <code>String object
* returned has exactly the same value the SQL
* <code>CHAR value had in the
* database, including any padding added by the database.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL,
* the result
* is <code>null.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setString
*/
String getString(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>BIT
* or <code>BOOLEAN parameter as a
* <code>boolean in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL,
* the result is <code>false.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setBoolean
*/
boolean getBoolean(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>TINYINT parameter
* as a <code>byte in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>0.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setByte
*/
byte getByte(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>SMALLINT parameter
* as a <code>short in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>0.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setShort
*/
short getShort(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>INTEGER parameter
* as an <code>int in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>0.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setInt
*/
int getInt(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>BIGINT parameter
* as a <code>long in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>0.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setLong
*/
long getLong(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>FLOAT parameter
* as a <code>float in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>0.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setFloat
*/
float getFloat(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>DOUBLE parameter as a double
* in the Java programming language.
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>0.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setDouble
*/
double getDouble(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>NUMERIC parameter as a
* <code>java.math.BigDecimal object with scale digits to
* the right of the decimal point.
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param scale the number of digits to the right of the decimal point
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @deprecated use <code>getBigDecimal(int parameterIndex)
* or <code>getBigDecimal(String parameterName)
* @see #setBigDecimal
*/
@Deprecated
BigDecimal getBigDecimal(int parameterIndex, int scale)
throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>BINARY or
* <code>VARBINARY parameter as an array of byte
* values in the Java programming language.
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setBytes
*/
byte[] getBytes(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>DATE parameter as a
* <code>java.sql.Date object.
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setDate
*/
java.sql.Date getDate(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>TIME parameter as a
* <code>java.sql.Time object.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setTime
*/
java.sql.Time getTime(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>TIMESTAMP parameter as a
* <code>java.sql.Timestamp object.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setTimestamp
*/
java.sql.Timestamp getTimestamp(int parameterIndex)
throws SQLException;
//----------------------------------------------------------------------
// Advanced features:
/**
* Retrieves the value of the designated parameter as an <code>Object
* in the Java programming language. If the value is an SQL <code>NULL,
* the driver returns a Java <code>null.
* <p>
* This method returns a Java object whose type corresponds to the JDBC
* type that was registered for this parameter using the method
* <code>registerOutParameter. By registering the target JDBC
* type as <code>java.sql.Types.OTHER, this method can be used
* to read database-specific abstract data types.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return A <code>java.lang.Object holding the OUT parameter value
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see Types
* @see #setObject
*/
Object getObject(int parameterIndex) throws SQLException;
//--------------------------JDBC 2.0-----------------------------
/**
* Retrieves the value of the designated JDBC <code>NUMERIC parameter as a
* <code>java.math.BigDecimal object with as many digits to the
* right of the decimal point as the value contains.
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value in full precision. If the value is
* SQL <code>NULL, the result is null.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setBigDecimal
* @since 1.2
*/
BigDecimal getBigDecimal(int parameterIndex) throws SQLException;
/**
* Returns an object representing the value of OUT parameter
* <code>parameterIndex and uses map for the custom
* mapping of the parameter value.
* <p>
* This method returns a Java object whose type corresponds to the
* JDBC type that was registered for this parameter using the method
* <code>registerOutParameter. By registering the target
* JDBC type as <code>java.sql.Types.OTHER, this method can
* be used to read database-specific abstract data types.
* @param parameterIndex the first parameter is 1, the second is 2, and so on
* @param map the mapping from SQL type names to Java classes
* @return a <code>java.lang.Object holding the OUT parameter value
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setObject
* @since 1.2
*/
Object getObject(int parameterIndex, java.util.Map<String,Class map)
throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>REF(<structured-type>)
* parameter as a {@link java.sql.Ref} object in the Java programming language.
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @return the parameter value as a <code>Ref object in the
* Java programming language. If the value was SQL <code>NULL, the value
* <code>null is returned.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
Ref getRef (int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>BLOB parameter as a
* {@link java.sql.Blob} object in the Java programming language.
* @param parameterIndex the first parameter is 1, the second is 2, and so on
* @return the parameter value as a <code>Blob object in the
* Java programming language. If the value was SQL <code>NULL, the value
* <code>null is returned.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
Blob getBlob (int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>CLOB parameter as a
* <code>java.sql.Clob object in the Java programming language.
* @param parameterIndex the first parameter is 1, the second is 2, and
* so on
* @return the parameter value as a <code>Clob object in the
* Java programming language. If the value was SQL <code>NULL, the
* value <code>null is returned.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
Clob getClob (int parameterIndex) throws SQLException;
/**
*
* Retrieves the value of the designated JDBC <code>ARRAY parameter as an
* {@link java.sql.Array} object in the Java programming language.
* @param parameterIndex the first parameter is 1, the second is 2, and
* so on
* @return the parameter value as an <code>Array object in
* the Java programming language. If the value was SQL <code>NULL, the
* value <code>null is returned.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.2
*/
Array getArray (int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>DATE parameter as a
* <code>java.sql.Date object, using
* the given <code>Calendar object
* to construct the date.
* With a <code>Calendar object, the driver
* can calculate the date taking into account a custom timezone and locale.
* If no <code>Calendar object is specified, the driver uses the
* default timezone and locale.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param cal the <code>Calendar object the driver will use
* to construct the date
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setDate
* @since 1.2
*/
java.sql.Date getDate(int parameterIndex, Calendar cal)
throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>TIME parameter as a
* <code>java.sql.Time object, using
* the given <code>Calendar object
* to construct the time.
* With a <code>Calendar object, the driver
* can calculate the time taking into account a custom timezone and locale.
* If no <code>Calendar object is specified, the driver uses the
* default timezone and locale.
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param cal the <code>Calendar object the driver will use
* to construct the time
* @return the parameter value; if the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setTime
* @since 1.2
*/
java.sql.Time getTime(int parameterIndex, Calendar cal)
throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>TIMESTAMP parameter as a
* <code>java.sql.Timestamp object, using
* the given <code>Calendar object to construct
* the <code>Timestamp object.
* With a <code>Calendar object, the driver
* can calculate the timestamp taking into account a custom timezone and locale.
* If no <code>Calendar object is specified, the driver uses the
* default timezone and locale.
*
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param cal the <code>Calendar object the driver will use
* to construct the timestamp
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #setTimestamp
* @since 1.2
*/
java.sql.Timestamp getTimestamp(int parameterIndex, Calendar cal)
throws SQLException;
/**
* Registers the designated output parameter.
* This version of
* the method <code>registerOutParameter
* should be used for a user-defined or <code>REF output parameter. Examples
* of user-defined types include: <code>STRUCT, DISTINCT,
* <code>JAVA_OBJECT, and named array types.
*<p>
* All OUT parameters must be registered
* before a stored procedure is executed.
* <p> For a user-defined parameter, the fully-qualified SQL
* type name of the parameter should also be given, while a <code>REF
* parameter requires that the fully-qualified type name of the
* referenced type be given. A JDBC driver that does not need the
* type code and type name information may ignore it. To be portable,
* however, applications should always provide these values for
* user-defined and <code>REF parameters.
*
* Although it is intended for user-defined and <code>REF parameters,
* this method may be used to register a parameter of any JDBC type.
* If the parameter does not have a user-defined or <code>REF type, the
* <i>typeName parameter is ignored.
*
* <P>Note: When reading the value of an out parameter, you
* must use the getter method whose Java type corresponds to the
* parameter's registered SQL type.
*
* @param parameterIndex the first parameter is 1, the second is 2,...
* @param sqlType a value from {@link java.sql.Types}
* @param typeName the fully-qualified name of an SQL structured type
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if <code>sqlType is
* a <code>ARRAY, BLOB, CLOB,
* <code>DATALINK, JAVA_OBJECT, NCHAR,
* <code>NCLOB, NVARCHAR, LONGNVARCHAR,
* <code>REF, ROWID, SQLXML
* or <code>STRUCT data type and the JDBC driver does not support
* this data type
* @see Types
* @since 1.2
*/
void registerOutParameter (int parameterIndex, int sqlType, String typeName)
throws SQLException;
//--------------------------JDBC 3.0-----------------------------
/**
* Registers the OUT parameter named
* <code>parameterName to the JDBC type
* <code>sqlType. All OUT parameters must be registered
* before a stored procedure is executed.
* <p>
* The JDBC type specified by <code>sqlType for an OUT
* parameter determines the Java type that must be used
* in the <code>get method to read the value of that parameter.
* <p>
* If the JDBC type expected to be returned to this output parameter
* is specific to this particular database, <code>sqlType
* should be <code>java.sql.Types.OTHER. The method
* {@link #getObject} retrieves the value.
* @param parameterName the name of the parameter
* @param sqlType the JDBC type code defined by <code>java.sql.Types.
* If the parameter is of JDBC type <code>NUMERIC
* or <code>DECIMAL, the version of
* <code>registerOutParameter that accepts a scale value
* should be used.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if <code>sqlType is
* a <code>ARRAY, BLOB, CLOB,
* <code>DATALINK, JAVA_OBJECT, NCHAR,
* <code>NCLOB, NVARCHAR, LONGNVARCHAR,
* <code>REF, ROWID, SQLXML
* or <code>STRUCT data type and the JDBC driver does not support
* this data type or if the JDBC driver does not support
* this method
* @since 1.4
* @see Types
*/
void registerOutParameter(String parameterName, int sqlType)
throws SQLException;
/**
* Registers the parameter named
* <code>parameterName to be of JDBC type
* <code>sqlType. All OUT parameters must be registered
* before a stored procedure is executed.
* <p>
* The JDBC type specified by <code>sqlType for an OUT
* parameter determines the Java type that must be used
* in the <code>get method to read the value of that parameter.
* <p>
* This version of <code>registerOutParameter should be
* used when the parameter is of JDBC type <code>NUMERIC
* or <code>DECIMAL.
*
* @param parameterName the name of the parameter
* @param sqlType SQL type code defined by <code>java.sql.Types.
* @param scale the desired number of digits to the right of the
* decimal point. It must be greater than or equal to zero.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if <code>sqlType is
* a <code>ARRAY, BLOB, CLOB,
* <code>DATALINK, JAVA_OBJECT, NCHAR,
* <code>NCLOB, NVARCHAR, LONGNVARCHAR,
* <code>REF, ROWID, SQLXML
* or <code>STRUCT data type and the JDBC driver does not support
* this data type or if the JDBC driver does not support
* this method
* @since 1.4
* @see Types
*/
void registerOutParameter(String parameterName, int sqlType, int scale)
throws SQLException;
/**
* Registers the designated output parameter. This version of
* the method <code>registerOutParameter
* should be used for a user-named or REF output parameter. Examples
* of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and
* named array types.
*<p>
* All OUT parameters must be registered
* before a stored procedure is executed.
* <p>
* 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.
*
* <P>Note: When reading the value of an out parameter, you
* must use the <code>getXXX method whose Java type XXX corresponds to the
* parameter's registered SQL type.
*
* @param parameterName the name of the parameter
* @param sqlType a value from {@link java.sql.Types}
* @param typeName the fully-qualified name of an SQL structured type
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if <code>sqlType is
* a <code>ARRAY, BLOB, CLOB,
* <code>DATALINK, JAVA_OBJECT, NCHAR,
* <code>NCLOB, NVARCHAR, LONGNVARCHAR,
* <code>REF, ROWID, SQLXML
* or <code>STRUCT data type and the JDBC driver does not support
* this data type or if the JDBC driver does not support
* this method
* @see Types
* @since 1.4
*/
void registerOutParameter (String parameterName, int sqlType, String typeName)
throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>DATALINK parameter as a
* <code>java.net.URL object.
*
* @param parameterIndex the first parameter is 1, the second is 2,...
* @return a <code>java.net.URL object that represents the
* JDBC <code>DATALINK value used as the designated
* parameter
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs,
* this method is called on a closed <code>CallableStatement,
* or if the URL being returned is
* not a valid URL on the Java platform
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setURL
* @since 1.4
*/
java.net.URL getURL(int parameterIndex) throws SQLException;
/**
* Sets the designated parameter to the given <code>java.net.URL object.
* The driver converts this to an SQL <code>DATALINK value when
* it sends it to the database.
*
* @param parameterName the name of the parameter
* @param val the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs;
* this method is called on a closed <code>CallableStatement
* or if a URL is malformed
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getURL
* @since 1.4
*/
void setURL(String parameterName, java.net.URL val) throws SQLException;
/**
* Sets the designated parameter to SQL <code>NULL.
*
* <P>Note: You must specify the parameter's SQL type.
*
* @param parameterName the name of the parameter
* @param sqlType the SQL type code defined in <code>java.sql.Types
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
void setNull(String parameterName, int sqlType) throws SQLException;
/**
* Sets the designated parameter to the given Java <code>boolean value.
* The driver converts this
* to an SQL <code>BIT or BOOLEAN value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @see #getBoolean
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
void setBoolean(String parameterName, boolean x) throws SQLException;
/**
* Sets the designated parameter to the given Java <code>byte value.
* The driver converts this
* to an SQL <code>TINYINT value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getByte
* @since 1.4
*/
void setByte(String parameterName, byte x) throws SQLException;
/**
* Sets the designated parameter to the given Java <code>short value.
* The driver converts this
* to an SQL <code>SMALLINT value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getShort
* @since 1.4
*/
void setShort(String parameterName, short x) throws SQLException;
/**
* Sets the designated parameter to the given Java <code>int value.
* The driver converts this
* to an SQL <code>INTEGER value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getInt
* @since 1.4
*/
void setInt(String parameterName, int x) throws SQLException;
/**
* Sets the designated parameter to the given Java <code>long value.
* The driver converts this
* to an SQL <code>BIGINT value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getLong
* @since 1.4
*/
void setLong(String parameterName, long x) throws SQLException;
/**
* Sets the designated parameter to the given Java <code>float value.
* The driver converts this
* to an SQL <code>FLOAT value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getFloat
* @since 1.4
*/
void setFloat(String parameterName, float x) throws SQLException;
/**
* Sets the designated parameter to the given Java <code>double value.
* The driver converts this
* to an SQL <code>DOUBLE value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getDouble
* @since 1.4
*/
void setDouble(String parameterName, double x) throws SQLException;
/**
* Sets the designated parameter to the given
* <code>java.math.BigDecimal value.
* The driver converts this to an SQL <code>NUMERIC value when
* it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getBigDecimal
* @since 1.4
*/
void setBigDecimal(String parameterName, BigDecimal x) throws SQLException;
/**
* Sets the designated parameter to the given Java <code>String value.
* The driver converts this
* to an SQL <code>VARCHAR or LONGVARCHAR value
* (depending on the argument's
* size relative to the driver's limits on <code>VARCHAR values)
* when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getString
* @since 1.4
*/
void setString(String parameterName, String x) throws SQLException;
/**
* Sets the designated parameter to the given Java array of bytes.
* The driver converts this to an SQL <code>VARBINARY or
* <code>LONGVARBINARY (depending on the argument's size relative
* to the driver's limits on <code>VARBINARY values) when it sends
* it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getBytes
* @since 1.4
*/
void setBytes(String parameterName, byte x[]) throws SQLException;
/**
* Sets the designated parameter to the given <code>java.sql.Date value
* using the default time zone of the virtual machine that is running
* the application.
* The driver converts this
* to an SQL <code>DATE value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getDate
* @since 1.4
*/
void setDate(String parameterName, java.sql.Date x)
throws SQLException;
/**
* Sets the designated parameter to the given <code>java.sql.Time value.
* The driver converts this
* to an SQL <code>TIME value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getTime
* @since 1.4
*/
void setTime(String parameterName, java.sql.Time x)
throws SQLException;
/**
* Sets the designated parameter to the given <code>java.sql.Timestamp value.
* The driver
* converts this to an SQL <code>TIMESTAMP value when it sends it to the
* database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getTimestamp
* @since 1.4
*/
void setTimestamp(String parameterName, java.sql.Timestamp x)
throws SQLException;
/**
* Sets the designated parameter to the given input stream, which will have
* the specified number of bytes.
* When a very large ASCII value is input to a <code>LONGVARCHAR
* parameter, it may be more practical to send it via a
* <code>java.io.InputStream. Data will be read from the stream
* as needed until end-of-file is reached. The JDBC driver will
* do any necessary conversion from ASCII to the database char format.
*
* <P>Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
*
* @param parameterName the name of the parameter
* @param x the Java input stream that contains the ASCII parameter value
* @param length the number of bytes in the stream
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
void setAsciiStream(String parameterName, java.io.InputStream x, int length)
throws SQLException;
/**
* Sets the designated parameter to the given input stream, which will have
* the specified number of bytes.
* When a very large binary value is input to a <code>LONGVARBINARY
* parameter, it may be more practical to send it via a
* <code>java.io.InputStream object. The data will be read from the stream
* as needed until end-of-file is reached.
*
* <P>Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
*
* @param parameterName the name of the parameter
* @param x the java input stream which contains the binary parameter value
* @param length the number of bytes in the stream
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
void setBinaryStream(String parameterName, java.io.InputStream x,
int length) throws SQLException;
/**
* Sets the value of the designated parameter with the given object.
*
* <p>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 <code>SQLData),
* the JDBC driver should call the method <code>SQLData.writeSQL to write it
* to the SQL data stream.
* If, on the other hand, the object is of a class implementing
* <code>Ref, Blob, Clob, NClob,
* <code>Struct, java.net.URL,
* or <code>Array, the driver should pass it to the database as a
* value of the corresponding SQL type.
* <P>
* Note that this method may be used to pass datatabase-
* specific abstract data types.
*
* @param parameterName the name of the parameter
* @param x the object containing the input parameter value
* @param targetSqlType the SQL type (as defined in java.sql.Types) to be
* sent to the database. The scale argument may further qualify this type.
* @param scale for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types,
* this is the number of digits after the decimal point. For all other
* types, this value will be ignored.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified targetSqlType
* @see Types
* @see #getObject
* @since 1.4
*/
void setObject(String parameterName, Object x, int targetSqlType, int scale)
throws SQLException;
/**
* Sets the value of the designated parameter with the given object.
*
* This method is similar to {@link #setObject(String parameterName,
* Object x, int targetSqlType, int scaleOrLength)},
* except that it assumes a scale of zero.
*
* @param parameterName the name of the parameter
* @param x the object containing the input parameter value
* @param targetSqlType the SQL type (as defined in java.sql.Types) to be
* sent to the database
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified targetSqlType
* @see #getObject
* @since 1.4
*/
void setObject(String parameterName, Object x, int targetSqlType)
throws SQLException;
/**
* Sets the value of the designated parameter with the given object.
*
* <p>The JDBC specification specifies a standard mapping from
* Java <code>Object types to SQL types. The given argument
* will be converted to the corresponding SQL type before being
* sent to the database.
* <p>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 <code>SQLData,
* the JDBC driver should call the method <code>SQLData.writeSQL
* to write it to the SQL data stream.
* If, on the other hand, the object is of a class implementing
* <code>Ref, Blob, Clob, NClob,
* <code>Struct, java.net.URL,
* or <code>Array, the driver should pass it to the database as a
* value of the corresponding SQL type.
* <P>
* 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.
*<p>
*<b>Note: Not all databases allow for a non-typed Null to be sent to
* the backend. For maximum portability, the <code>setNull or the
* <code>setObject(String parameterName, Object x, int sqlType)
* method should be used
* instead of <code>setObject(String parameterName, Object x).
*<p>
* @param parameterName the name of the parameter
* @param x the object containing the input parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs,
* this method is called on a closed <code>CallableStatement or if the given
* <code>Object parameter is ambiguous
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getObject
* @since 1.4
*/
void setObject(String parameterName, Object x) throws SQLException;
/**
* Sets the designated parameter to the given <code>Reader
* object, which is the given number of characters long.
* When a very large UNICODE value is input to a <code>LONGVARCHAR
* parameter, it may be more practical to send it via a
* <code>java.io.Reader object. The data will be read from the stream
* as needed until end-of-file is reached. The JDBC driver will
* do any necessary conversion from UNICODE to the database char format.
*
* <P>Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
*
* @param parameterName the name of the parameter
* @param reader the <code>java.io.Reader object that
* contains the UNICODE data used as the designated parameter
* @param length the number of characters in the stream
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
void setCharacterStream(String parameterName,
java.io.Reader reader,
int length) throws SQLException;
/**
* Sets the designated parameter to the given <code>java.sql.Date value,
* using the given <code>Calendar object. The driver uses
* the <code>Calendar object to construct an SQL DATE value,
* which the driver then sends to the database. With a
* a <code>Calendar object, the driver can calculate the date
* taking into account a custom timezone. If no
* <code>Calendar object is specified, the driver uses the default
* timezone, which is that of the virtual machine running the application.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @param cal the <code>Calendar object the driver will use
* to construct the date
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getDate
* @since 1.4
*/
void setDate(String parameterName, java.sql.Date x, Calendar cal)
throws SQLException;
/**
* Sets the designated parameter to the given <code>java.sql.Time value,
* using the given <code>Calendar object. The driver uses
* the <code>Calendar object to construct an SQL TIME value,
* which the driver then sends to the database. With a
* a <code>Calendar object, the driver can calculate the time
* taking into account a custom timezone. If no
* <code>Calendar object is specified, the driver uses the default
* timezone, which is that of the virtual machine running the application.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @param cal the <code>Calendar object the driver will use
* to construct the time
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getTime
* @since 1.4
*/
void setTime(String parameterName, java.sql.Time x, Calendar cal)
throws SQLException;
/**
* Sets the designated parameter to the given <code>java.sql.Timestamp value,
* using the given <code>Calendar object. The driver uses
* the <code>Calendar object to construct an SQL TIMESTAMP value,
* which the driver then sends to the database. With a
* a <code>Calendar object, the driver can calculate the timestamp
* taking into account a custom timezone. If no
* <code>Calendar object is specified, the driver uses the default
* timezone, which is that of the virtual machine running the application.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @param cal the <code>Calendar object the driver will use
* to construct the timestamp
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #getTimestamp
* @since 1.4
*/
void setTimestamp(String parameterName, java.sql.Timestamp x, Calendar cal)
throws SQLException;
/**
* Sets the designated parameter to SQL <code>NULL.
* This version of the method <code>setNull should
* be used for user-defined types and REF type parameters. Examples
* of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and
* named array types.
*
* <P>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.
* <p>
* Although it is intended for user-defined and Ref parameters,
* this method may be used to set a null parameter of any JDBC type.
* If the parameter does not have a user-defined or REF type, the given
* typeName is ignored.
*
*
* @param parameterName the name of the parameter
* @param sqlType a value from <code>java.sql.Types
* @param typeName the fully-qualified name of an SQL user-defined type;
* ignored if the parameter is not a user-defined type or
* SQL <code>REF value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
void setNull (String parameterName, int sqlType, String typeName)
throws SQLException;
/**
* Retrieves the value of a JDBC <code>CHAR, VARCHAR,
* or <code>LONGVARCHAR parameter as a String in
* the Java programming language.
* <p>
* For the fixed-length type JDBC <code>CHAR,
* the <code>String object
* returned has exactly the same value the SQL
* <code>CHAR value had in the
* database, including any padding added by the database.
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setString
* @since 1.4
*/
String getString(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>BIT or BOOLEAN
* parameter as a
* <code>boolean in the Java programming language.
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>false.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setBoolean
* @since 1.4
*/
boolean getBoolean(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>TINYINT parameter as a byte
* in the Java programming language.
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>0.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setByte
* @since 1.4
*/
byte getByte(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>SMALLINT parameter as a short
* in the Java programming language.
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>0.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setShort
* @since 1.4
*/
short getShort(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>INTEGER parameter as an int
* in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL,
* the result is <code>0.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setInt
* @since 1.4
*/
int getInt(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>BIGINT parameter as a long
* in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL,
* the result is <code>0.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setLong
* @since 1.4
*/
long getLong(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>FLOAT parameter as a float
* in the Java programming language.
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL,
* the result is <code>0.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setFloat
* @since 1.4
*/
float getFloat(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>DOUBLE parameter as a double
* in the Java programming language.
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL,
* the result is <code>0.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setDouble
* @since 1.4
*/
double getDouble(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>BINARY or VARBINARY
* parameter as an array of <code>byte values in the Java
* programming language.
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL, the result is
* <code>null.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setBytes
* @since 1.4
*/
byte[] getBytes(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>DATE parameter as a
* <code>java.sql.Date object.
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setDate
* @since 1.4
*/
java.sql.Date getDate(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>TIME parameter as a
* <code>java.sql.Time object.
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setTime
* @since 1.4
*/
java.sql.Time getTime(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>TIMESTAMP parameter as a
* <code>java.sql.Timestamp object.
* @param parameterName the name of the parameter
* @return the parameter value. If the value is SQL <code>NULL, the result
* is <code>null.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setTimestamp
* @since 1.4
*/
java.sql.Timestamp getTimestamp(String parameterName) throws SQLException;
/**
* Retrieves the value of a parameter as an <code>Object in the Java
* programming language. If the value is an SQL <code>NULL, the
* driver returns a Java <code>null.
* <p>
* This method returns a Java object whose type corresponds to the JDBC
* type that was registered for this parameter using the method
* <code>registerOutParameter. By registering the target JDBC
* type as <code>java.sql.Types.OTHER, this method can be used
* to read database-specific abstract data types.
* @param parameterName the name of the parameter
* @return A <code>java.lang.Object holding the OUT parameter value.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see Types
* @see #setObject
* @since 1.4
*/
Object getObject(String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>NUMERIC parameter as a
* <code>java.math.BigDecimal object with as many digits to the
* right of the decimal point as the value contains.
* @param parameterName the name of the parameter
* @return the parameter value in full precision. If the value is
* SQL <code>NULL, the result is null.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setBigDecimal
* @since 1.4
*/
BigDecimal getBigDecimal(String parameterName) throws SQLException;
/**
* Returns an object representing the value of OUT parameter
* <code>parameterName and uses map for the custom
* mapping of the parameter value.
* <p>
* This method returns a Java object whose type corresponds to the
* JDBC type that was registered for this parameter using the method
* <code>registerOutParameter. By registering the target
* JDBC type as <code>java.sql.Types.OTHER, this method can
* be used to read database-specific abstract data types.
* @param parameterName the name of the parameter
* @param map the mapping from SQL type names to Java classes
* @return a <code>java.lang.Object holding the OUT parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setObject
* @since 1.4
*/
Object getObject(String parameterName, java.util.Map<String,Class map)
throws SQLException;
/**
* Retrieves the value of a JDBC <code>REF(<structured-type>)
* parameter as a {@link java.sql.Ref} object in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value as a <code>Ref object in the
* Java programming language. If the value was SQL <code>NULL,
* the value <code>null is returned.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
Ref getRef (String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>BLOB parameter as a
* {@link java.sql.Blob} object in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value as a <code>Blob object in the
* Java programming language. If the value was SQL <code>NULL,
* the value <code>null is returned.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
Blob getBlob (String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>CLOB parameter as a
* <code>java.sql.Clob object in the Java programming language.
* @param parameterName the name of the parameter
* @return the parameter value as a <code>Clob object in the
* Java programming language. If the value was SQL <code>NULL,
* the value <code>null is returned.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
Clob getClob (String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>ARRAY parameter as an
* {@link java.sql.Array} object in the Java programming language.
*
* @param parameterName the name of the parameter
* @return the parameter value as an <code>Array object in
* Java programming language. If the value was SQL <code>NULL,
* the value <code>null is returned.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.4
*/
Array getArray (String parameterName) throws SQLException;
/**
* Retrieves the value of a JDBC <code>DATE parameter as a
* <code>java.sql.Date object, using
* the given <code>Calendar object
* to construct the date.
* With a <code>Calendar object, the driver
* can calculate the date taking into account a custom timezone and locale.
* If no <code>Calendar object is specified, the driver uses the
* default timezone and locale.
*
* @param parameterName the name of the parameter
* @param cal the <code>Calendar object the driver will use
* to construct the date
* @return the parameter value. If the value is SQL <code>NULL,
* the result is <code>null.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setDate
* @since 1.4
*/
java.sql.Date getDate(String parameterName, Calendar cal)
throws SQLException;
/**
* Retrieves the value of a JDBC <code>TIME parameter as a
* <code>java.sql.Time object, using
* the given <code>Calendar object
* to construct the time.
* With a <code>Calendar object, the driver
* can calculate the time taking into account a custom timezone and locale.
* If no <code>Calendar object is specified, the driver uses the
* default timezone and locale.
*
* @param parameterName the name of the parameter
* @param cal the <code>Calendar object the driver will use
* to construct the time
* @return the parameter value; if the value is SQL <code>NULL, the result is
* <code>null.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setTime
* @since 1.4
*/
java.sql.Time getTime(String parameterName, Calendar cal)
throws SQLException;
/**
* Retrieves the value of a JDBC <code>TIMESTAMP parameter as a
* <code>java.sql.Timestamp object, using
* the given <code>Calendar object to construct
* the <code>Timestamp object.
* With a <code>Calendar object, the driver
* can calculate the timestamp taking into account a custom timezone and locale.
* If no <code>Calendar object is specified, the driver uses the
* default timezone and locale.
*
*
* @param parameterName the name of the parameter
* @param cal the <code>Calendar object the driver will use
* to construct the timestamp
* @return the parameter value. If the value is SQL <code>NULL, the result is
* <code>null.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setTimestamp
* @since 1.4
*/
java.sql.Timestamp getTimestamp(String parameterName, Calendar cal)
throws SQLException;
/**
* Retrieves the value of a JDBC <code>DATALINK parameter as a
* <code>java.net.URL object.
*
* @param parameterName the name of the parameter
* @return the parameter value as a <code>java.net.URL object in the
* Java programming language. If the value was SQL <code>NULL, the
* value <code>null is returned.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs,
* this method is called on a closed <code>CallableStatement,
* or if there is a problem with the URL
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @see #setURL
* @since 1.4
*/
java.net.URL getURL(String parameterName) throws SQLException;
//------------------------- JDBC 4.0 -----------------------------------
/**
* Retrieves the value of the designated JDBC <code>ROWID parameter as a
* <code>java.sql.RowId object.
*
* @param parameterIndex the first parameter is 1, the second is 2,...
* @return a <code>RowId object that represents the JDBC ROWID
* value is used as the designated parameter. If the parameter contains
* a SQL <code>NULL, then a null value is returned.
* @throws SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
RowId getRowId(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>ROWID parameter as a
* <code>java.sql.RowId object.
*
* @param parameterName the name of the parameter
* @return a <code>RowId object that represents the JDBC ROWID
* value is used as the designated parameter. If the parameter contains
* a SQL <code>NULL, then a null value is returned.
* @throws SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
RowId getRowId(String parameterName) throws SQLException;
/**
* Sets the designated parameter to the given <code>java.sql.RowId object. The
* driver converts this to a SQL <code>ROWID when it sends it to the
* database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @throws SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
void setRowId(String parameterName, RowId x) throws SQLException;
/**
* Sets the designated parameter to the given <code>String object.
* The driver converts this to a SQL <code>NCHAR or
* <code>NVARCHAR or LONGNVARCHAR
* @param parameterName the name of the parameter to be set
* @param value the parameter value
* @throws SQLException if parameterName does not correspond to a named
* parameter; if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
void setNString(String parameterName, String value)
throws SQLException;
/**
* Sets the designated parameter to a <code>Reader object. The
* <code>Reader reads the data till end-of-file is reached. The
* driver does the necessary conversion from Java character format to
* the national character set in the database.
* @param parameterName the name of the parameter to be set
* @param value the parameter value
* @param length the number of characters in the parameter data.
* @throws SQLException if parameterName does not correspond to a named
* parameter; if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
void setNCharacterStream(String parameterName, Reader value, long length)
throws SQLException;
/**
* Sets the designated parameter to a <code>java.sql.NClob object. The object
* implements the <code>java.sql.NClob interface. This NClob
* object maps to a SQL <code>NCLOB.
* @param parameterName the name of the parameter to be set
* @param value the parameter value
* @throws SQLException if parameterName does not correspond to a named
* parameter; if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
void setNClob(String parameterName, NClob value) throws SQLException;
/**
* Sets the designated parameter to a <code>Reader object. The reader must contain the number
* of characters specified by length otherwise a <code>SQLException will be
* generated when the <code>CallableStatement is executed.
* This method differs from the <code>setCharacterStream (int, Reader, int) method
* because it informs the driver that the parameter value should be sent to
* the server as a <code>CLOB. When the setCharacterStream method is used, the
* driver may have to do extra work to determine whether the parameter
* data should be send to the server as a <code>LONGVARCHAR or a CLOB
* @param parameterName the name of the parameter to be set
* @param reader An object that contains the data to set the parameter value to.
* @param length the number of characters in the parameter data.
* @throws SQLException if parameterName does not correspond to a named
* parameter; if the length specified is less than zero;
* a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
*
* @since 1.6
*/
void setClob(String parameterName, Reader reader, long length)
throws SQLException;
/**
* Sets the designated parameter to a <code>InputStream object. The inputstream must contain the number
* of characters specified by length, otherwise a <code>SQLException will be
* generated when the <code>CallableStatement is executed.
* This method differs from the <code>setBinaryStream (int, InputStream, int)
* method because it informs the driver that the parameter value should be
* sent to the server as a <code>BLOB. When the setBinaryStream method is used,
* the driver may have to do extra work to determine whether the parameter
* data should be sent to the server as a <code>LONGVARBINARY or a BLOB
*
* @param parameterName the name of the parameter to be set
* the second is 2, ...
*
* @param inputStream An object that contains the data to set the parameter
* value to.
* @param length the number of bytes in the parameter data.
* @throws SQLException if parameterName does not correspond to a named
* parameter; if the length specified
* is less than zero; if the number of bytes in the inputstream does not match
* the specified length; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
*
* @since 1.6
*/
void setBlob(String parameterName, InputStream inputStream, long length)
throws SQLException;
/**
* Sets the designated parameter to a <code>Reader object. The reader must contain the number
* of characters specified by length otherwise a <code>SQLException will be
* generated when the <code>CallableStatement is executed.
* This method differs from the <code>setCharacterStream (int, Reader, int) method
* because it informs the driver that the parameter value should be sent to
* the server as a <code>NCLOB. When the setCharacterStream method is used, the
* driver may have to do extra work to determine whether the parameter
* data should be send to the server as a <code>LONGNVARCHAR or a NCLOB
*
* @param parameterName the name of the parameter to be set
* @param reader An object that contains the data to set the parameter value to.
* @param length the number of characters in the parameter data.
* @throws SQLException if parameterName does not correspond to a named
* parameter; if the length specified is less than zero;
* if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
void setNClob(String parameterName, Reader reader, long length)
throws SQLException;
/**
* Retrieves the value of the designated JDBC <code>NCLOB parameter as a
* <code>java.sql.NClob object in the Java programming language.
*
* @param parameterIndex the first parameter is 1, the second is 2, and
* so on
* @return the parameter value as a <code>NClob object in the
* Java programming language. If the value was SQL <code>NULL, the
* value <code>null is returned.
* @exception SQLException if the parameterIndex is not valid;
* if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
NClob getNClob (int parameterIndex) throws SQLException;
/**
* Retrieves the value of a JDBC <code>NCLOB parameter as a
* <code>java.sql.NClob object in the Java programming language.
* @param parameterName the name of the parameter
* @return the parameter value as a <code>NClob object in the
* Java programming language. If the value was SQL <code>NULL,
* the value <code>null is returned.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
NClob getNClob (String parameterName) throws SQLException;
/**
* Sets the designated parameter to the given <code>java.sql.SQLXML object. The driver converts this to an
* <code>SQL XML value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param xmlObject a <code>SQLXML object that maps an SQL XML value
* @throws SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs;
* this method is called on a closed <code>CallableStatement or
* the <code>java.xml.transform.Result,
* <code>Writer or OutputStream has not been closed for the SQLXML object
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
*
* @since 1.6
*/
void setSQLXML(String parameterName, SQLXML xmlObject) throws SQLException;
/**
* Retrieves the value of the designated <code>SQL XML parameter as a
* <code>java.sql.SQLXML object in the Java programming language.
* @param parameterIndex index of the first parameter is 1, the second is 2, ...
* @return a <code>SQLXML object that maps an SQL XML value
* @throws SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
SQLXML getSQLXML(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated <code>SQL XML parameter as a
* <code>java.sql.SQLXML object in the Java programming language.
* @param parameterName the name of the parameter
* @return a <code>SQLXML object that maps an SQL XML value
* @throws SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
SQLXML getSQLXML(String parameterName) throws SQLException;
/**
* Retrieves the value of the designated <code>NCHAR,
* <code>NVARCHAR
* or <code>LONGNVARCHAR parameter as
* a <code>String in the Java programming language.
* <p>
* For the fixed-length type JDBC <code>NCHAR,
* the <code>String object
* returned has exactly the same value the SQL
* <code>NCHAR value had in the
* database, including any padding added by the database.
*
* @param parameterIndex index of the first parameter is 1, the second is 2, ...
* @return a <code>String object that maps an
* <code>NCHAR, NVARCHAR or LONGNVARCHAR value
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
* @see #setNString
*/
String getNString(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated <code>NCHAR,
* <code>NVARCHAR
* or <code>LONGNVARCHAR parameter as
* a <code>String in the Java programming language.
* <p>
* For the fixed-length type JDBC <code>NCHAR,
* the <code>String object
* returned has exactly the same value the SQL
* <code>NCHAR value had in the
* database, including any padding added by the database.
*
* @param parameterName the name of the parameter
* @return a <code>String object that maps an
* <code>NCHAR, NVARCHAR or LONGNVARCHAR value
* @exception SQLException if parameterName does not correspond to a named
* parameter;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
* @see #setNString
*/
String getNString(String parameterName) throws SQLException;
/**
* Retrieves the value of the designated parameter as a
* <code>java.io.Reader object in the Java programming language.
* It is intended for use when
* accessing <code>NCHAR,NVARCHAR
* and <code>LONGNVARCHAR parameters.
*
* @return a <code>java.io.Reader object that contains the parameter
* value; if the value is SQL <code>NULL, the value returned is
* <code>null in the Java programming language.
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
java.io.Reader getNCharacterStream(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated parameter as a
* <code>java.io.Reader object in the Java programming language.
* It is intended for use when
* accessing <code>NCHAR,NVARCHAR
* and <code>LONGNVARCHAR parameters.
*
* @param parameterName the name of the parameter
* @return a <code>java.io.Reader object that contains the parameter
* value; if the value is SQL <code>NULL, the value returned is
* <code>null in the Java programming language
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
java.io.Reader getNCharacterStream(String parameterName) throws SQLException;
/**
* Retrieves the value of the designated parameter as a
* <code>java.io.Reader object in the Java programming language.
*
* @return a <code>java.io.Reader object that contains the parameter
* value; if the value is SQL <code>NULL, the value returned is
* <code>null in the Java programming language.
* @param parameterIndex the first parameter is 1, the second is 2, ...
* @exception SQLException if the parameterIndex is not valid; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @since 1.6
*/
java.io.Reader getCharacterStream(int parameterIndex) throws SQLException;
/**
* Retrieves the value of the designated parameter as a
* <code>java.io.Reader object in the Java programming language.
*
* @param parameterName the name of the parameter
* @return a <code>java.io.Reader object that contains the parameter
* value; if the value is SQL <code>NULL, the value returned is
* <code>null in the Java programming language
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
java.io.Reader getCharacterStream(String parameterName) throws SQLException;
/**
* Sets the designated parameter to the given <code>java.sql.Blob object.
* The driver converts this to an SQL <code>BLOB value when it
* sends it to the database.
*
* @param parameterName the name of the parameter
* @param x a <code>Blob object that maps an SQL BLOB value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
void setBlob (String parameterName, Blob x) throws SQLException;
/**
* Sets the designated parameter to the given <code>java.sql.Clob object.
* The driver converts this to an SQL <code>CLOB value when it
* sends it to the database.
*
* @param parameterName the name of the parameter
* @param x a <code>Clob object that maps an SQL CLOB value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
void setClob (String parameterName, Clob x) throws SQLException;
/**
* Sets the designated parameter to the given input stream, which will have
* the specified number of bytes.
* When a very large ASCII value is input to a <code>LONGVARCHAR
* parameter, it may be more practical to send it via a
* <code>java.io.InputStream. Data will be read from the stream
* as needed until end-of-file is reached. The JDBC driver will
* do any necessary conversion from ASCII to the database char format.
*
* <P>Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
*
* @param parameterName the name of the parameter
* @param x the Java input stream that contains the ASCII parameter value
* @param length the number of bytes in the stream
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
void setAsciiStream(String parameterName, java.io.InputStream x, long length)
throws SQLException;
/**
* Sets the designated parameter to the given input stream, which will have
* the specified number of bytes.
* When a very large binary value is input to a <code>LONGVARBINARY
* parameter, it may be more practical to send it via a
* <code>java.io.InputStream object. The data will be read from the stream
* as needed until end-of-file is reached.
*
* <P>Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
*
* @param parameterName the name of the parameter
* @param x the java input stream which contains the binary parameter value
* @param length the number of bytes in the stream
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
void setBinaryStream(String parameterName, java.io.InputStream x,
long length) throws SQLException;
/**
* Sets the designated parameter to the given <code>Reader
* object, which is the given number of characters long.
* When a very large UNICODE value is input to a <code>LONGVARCHAR
* parameter, it may be more practical to send it via a
* <code>java.io.Reader object. The data will be read from the stream
* as needed until end-of-file is reached. The JDBC driver will
* do any necessary conversion from UNICODE to the database char format.
*
* <P>Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
*
* @param parameterName the name of the parameter
* @param reader the <code>java.io.Reader object that
* contains the UNICODE data used as the designated parameter
* @param length the number of characters in the stream
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
*/
void setCharacterStream(String parameterName,
java.io.Reader reader,
long length) throws SQLException;
//--
/**
* Sets the designated parameter to the given input stream.
* When a very large ASCII value is input to a <code>LONGVARCHAR
* parameter, it may be more practical to send it via a
* <code>java.io.InputStream. Data will be read from the stream
* as needed until end-of-file is reached. The JDBC driver will
* do any necessary conversion from ASCII to the database char format.
*
* <P>Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
* <P>Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* <code>setAsciiStream which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param x the Java input stream that contains the ASCII parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
void setAsciiStream(String parameterName, java.io.InputStream x)
throws SQLException;
/**
* Sets the designated parameter to the given input stream.
* When a very large binary value is input to a <code>LONGVARBINARY
* parameter, it may be more practical to send it via a
* <code>java.io.InputStream object. The data will be read from the
* stream as needed until end-of-file is reached.
*
* <P>Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
* <P>Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* <code>setBinaryStream which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param x the java input stream which contains the binary parameter value
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
void setBinaryStream(String parameterName, java.io.InputStream x)
throws SQLException;
/**
* Sets the designated parameter to the given <code>Reader
* object.
* When a very large UNICODE value is input to a <code>LONGVARCHAR
* parameter, it may be more practical to send it via a
* <code>java.io.Reader object. The data will be read from the stream
* as needed until end-of-file is reached. The JDBC driver will
* do any necessary conversion from UNICODE to the database char format.
*
* <P>Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
* <P>Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* <code>setCharacterStream which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param reader the <code>java.io.Reader object that contains the
* Unicode data
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
void setCharacterStream(String parameterName,
java.io.Reader reader) throws SQLException;
/**
* Sets the designated parameter to a <code>Reader object. The
* <code>Reader reads the data till end-of-file is reached. The
* driver does the necessary conversion from Java character format to
* the national character set in the database.
* <P>Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
* <P>Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* <code>setNCharacterStream which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param value the parameter value
* @throws SQLException if parameterName does not correspond to a named
* parameter; if the driver does not support national
* character sets; if the driver can detect that a data conversion
* error could occur; if a database access error occurs; or
* this method is called on a closed <code>CallableStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
void setNCharacterStream(String parameterName, Reader value) throws SQLException;
/**
* Sets the designated parameter to a <code>Reader object.
* This method differs from the <code>setCharacterStream (int, Reader) method
* because it informs the driver that the parameter value should be sent to
* the server as a <code>CLOB. When the setCharacterStream method is used, the
* driver may have to do extra work to determine whether the parameter
* data should be send to the server as a <code>LONGVARCHAR or a CLOB
*
* <P>Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* <code>setClob which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param reader An object that contains the data to set the parameter value to.
* @throws SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or this method is called on
* a closed <code>CallableStatement
*
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
void setClob(String parameterName, Reader reader)
throws SQLException;
/**
* Sets the designated parameter to a <code>InputStream object.
* This method differs from the <code>setBinaryStream (int, InputStream)
* method because it informs the driver that the parameter value should be
* sent to the server as a <code>BLOB. When the setBinaryStream method is used,
* the driver may have to do extra work to determine whether the parameter
* data should be send to the server as a <code>LONGVARBINARY or a BLOB
*
* <P>Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* <code>setBlob which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param inputStream An object that contains the data to set the parameter
* value to.
* @throws SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since 1.6
*/
void setBlob(String parameterName, InputStream inputStream)
throws SQLException;
/**
* Sets the designated parameter to a <code>Reader object.
* This method differs from the <code>setCharacterStream (int, Reader) method
* because it informs the driver that the parameter value should be sent to
* the server as a <code>NCLOB. When the setCharacterStream method is used, the
* driver may have to do extra work to determine whether the parameter
* data should be send to the server as a <code>LONGNVARCHAR or a NCLOB
* <P>Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
* <code>setNClob which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param reader An object that contains the data to set the parameter value to.
* @throws SQLException if parameterName does not correspond to a named
* parameter; if the driver does not support national character sets;
* if the driver can detect that a data conversion
* error could occur; if a database access error occurs or
* this method is called on a closed <code>CallableStatement
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since 1.6
*/
void setNClob(String parameterName, Reader reader)
throws SQLException;
//------------------------- JDBC 4.1 -----------------------------------
/**
*<p>Returns an object representing the value of OUT parameter
* {@code parameterIndex} and will convert from the
* SQL type of the parameter to the requested Java data type, if the
* conversion is supported. If the conversion is not
* supported or null is specified for the type, a
* <code>SQLException is thrown.
*<p>
* At a minimum, an implementation must support the conversions defined in
* Appendix B, Table B-3 and conversion of appropriate user defined SQL
* types to a Java type which implements {@code SQLData}, or {@code Struct}.
* Additional conversions may be supported and are vendor defined.
*
* @param parameterIndex the first parameter is 1, the second is 2, and so on
* @param type Class representing the Java data type to convert the
* designated parameter to.
* @param <T> the type of the class modeled by this Class object
* @return an instance of {@code type} holding the OUT parameter value
* @throws SQLException if conversion is not supported, type is null or
* another error occurs. The getCause() method of the
* exception may provide a more detailed exception, for example, if
* a conversion error occurs
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.7
*/
public <T> T getObject(int parameterIndex, Class type) throws SQLException;
/**
*<p>Returns an object representing the value of OUT parameter
* {@code parameterName} and will convert from the
* SQL type of the parameter to the requested Java data type, if the
* conversion is supported. If the conversion is not
* supported or null is specified for the type, a
* <code>SQLException is thrown.
*<p>
* At a minimum, an implementation must support the conversions defined in
* Appendix B, Table B-3 and conversion of appropriate user defined SQL
* types to a Java type which implements {@code SQLData}, or {@code Struct}.
* Additional conversions may be supported and are vendor defined.
*
* @param parameterName the name of the parameter
* @param type Class representing the Java data type to convert
* the designated parameter to.
* @param <T> the type of the class modeled by this Class object
* @return an instance of {@code type} holding the OUT parameter
* value
* @throws SQLException if conversion is not supported, type is null or
* another error occurs. The getCause() method of the
* exception may provide a more detailed exception, for example, if
* a conversion error occurs
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.7
*/
public <T> T getObject(String parameterName, Class type) throws SQLException;
//------------------------- JDBC 4.2 -----------------------------------
/**
* <p>Sets the value of the designated parameter with the given object.
*
* If the second argument is an {@code InputStream} then the stream
* must contain the number of bytes specified by scaleOrLength.
* If the second argument is a {@code Reader} then the reader must
* contain the number of characters specified
* by scaleOrLength. If these conditions are not true the driver
* will generate a
* {@code SQLException} when the prepared statement is executed.
*
* <p>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 {@code SQLData}),
* the JDBC driver should call the method {@code SQLData.writeSQL} to
* write it to the SQL data stream.
* If, on the other hand, the object is of a class implementing
* {@code Ref}, {@code Blob}, {@code Clob}, {@code NClob},
* {@code Struct}, {@code java.net.URL},
* or {@code Array}, the driver should pass it to the database as a
* value of the corresponding SQL type.
*
* <p>Note that this method may be used to pass database-specific
* abstract data types.
*<P>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param parameterName the name of the parameter
* @param x the object containing the input parameter value
* @param targetSqlType the SQL type to be
* sent to the database. The scale argument may further qualify this type.
* @param scaleOrLength for {@code java.sql.JDBCType.DECIMAL}
* or {@code java.sql.JDBCType.NUMERIC types},
* this is the number of digits after the decimal point. For
* Java Object types {@code InputStream} and {@code Reader},
* this is the length
* of the data in the stream or reader. For all other types,
* this value will be ignored.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs
* or this method is called on a closed {@code CallableStatement} or
* if the Java Object specified by x is an InputStream
* or Reader object and the value of the scale parameter is less
* than zero
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified targetSqlType
* @see JDBCType
* @see SQLType
*
* @since 1.8
*/
default void setObject(String parameterName, Object x, SQLType targetSqlType,
int scaleOrLength) throws SQLException {
throw new SQLFeatureNotSupportedException("setObject not implemented");
}
/**
* Sets the value of the designated parameter with the given object.
*
* This method is similar to {@link #setObject(String parameterName,
* Object x, SQLType targetSqlType, int scaleOrLength)},
* except that it assumes a scale of zero.
*<P>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param parameterName the name of the parameter
* @param x the object containing the input parameter value
* @param targetSqlType the SQL type to be sent to the database
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs
* or this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified targetSqlType
* @see JDBCType
* @see SQLType
* @since 1.8
*/
default void setObject(String parameterName, Object x, SQLType targetSqlType)
throws SQLException {
throw new SQLFeatureNotSupportedException("setObject not implemented");
}
/**
* Registers the OUT parameter in ordinal position
* {@code parameterIndex} to the JDBC type
* {@code sqlType}. All OUT parameters must be registered
* before a stored procedure is executed.
* <p>
* The JDBC type specified by {@code sqlType} for an OUT
* parameter determines the Java type that must be used
* in the {@code get} method to read the value of that parameter.
* <p>
* If the JDBC type expected to be returned to this output parameter
* is specific to this particular database, {@code sqlType}
* may be {@code JDBCType.OTHER} or a {@code SQLType} that is supported by
* the JDBC driver. The method
* {@link #getObject} retrieves the value.
*<P>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param sqlType the JDBC type code defined by {@code SQLType} to use to
* register the OUT Parameter.
* If the parameter is of JDBC type {@code JDBCType.NUMERIC}
* or {@code JDBCType.DECIMAL}, the version of
* {@code registerOutParameter} that accepts a scale value
* should be used.
*
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified sqlType
* @see JDBCType
* @see SQLType
* @since 1.8
*/
default void registerOutParameter(int parameterIndex, SQLType sqlType)
throws SQLException {
throw new SQLFeatureNotSupportedException("registerOutParameter not implemented");
}
/**
* Registers the parameter in ordinal position
* {@code parameterIndex} to be of JDBC type
* {@code sqlType}. All OUT parameters must be registered
* before a stored procedure is executed.
* <p>
* The JDBC type specified by {@code sqlType} for an OUT
* parameter determines the Java type that must be used
* in the {@code get} method to read the value of that parameter.
* <p>
* This version of {@code registerOutParameter} should be
* used when the parameter is of JDBC type {@code JDBCType.NUMERIC}
* or {@code JDBCType.DECIMAL}.
*<P>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param parameterIndex the first parameter is 1, the second is 2,
* and so on
* @param sqlType the JDBC type code defined by {@code SQLType} to use to
* register the OUT Parameter.
* @param scale the desired number of digits to the right of the
* decimal point. It must be greater than or equal to zero.
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified sqlType
* @see JDBCType
* @see SQLType
* @since 1.8
*/
default void registerOutParameter(int parameterIndex, SQLType sqlType,
int scale) throws SQLException {
throw new SQLFeatureNotSupportedException("registerOutParameter not implemented");
}
/**
* Registers the designated output parameter.
* This version of
* the method {@code registerOutParameter}
* should be used for a user-defined or {@code REF} output parameter.
* Examples
* of user-defined types include: {@code STRUCT}, {@code DISTINCT},
* {@code JAVA_OBJECT}, and named array types.
*<p>
* All OUT parameters must be registered
* before a stored procedure is executed.
* <p> For a user-defined parameter, the fully-qualified SQL
* type name of the parameter should also be given, while a {@code REF}
* parameter requires that the fully-qualified type name of the
* referenced type be given. A JDBC driver that does not need the
* type code and type name information may ignore it. To be portable,
* however, applications should always provide these values for
* user-defined and {@code REF} parameters.
*
* Although it is intended for user-defined and {@code REF} parameters,
* this method may be used to register a parameter of any JDBC type.
* If the parameter does not have a user-defined or {@code REF} type, the
* <i>typeName parameter is ignored.
*
* <P>Note: When reading the value of an out parameter, you
* must use the getter method whose Java type corresponds to the
* parameter's registered SQL type.
*<P>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param parameterIndex the first parameter is 1, the second is 2,...
* @param sqlType the JDBC type code defined by {@code SQLType} to use to
* register the OUT Parameter.
* @param typeName the fully-qualified name of an SQL structured type
* @exception SQLException if the parameterIndex is not valid;
* if a database access error occurs or
* this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified sqlType
* @see JDBCType
* @see SQLType
* @since 1.8
*/
default void registerOutParameter (int parameterIndex, SQLType sqlType,
String typeName) throws SQLException {
throw new SQLFeatureNotSupportedException("registerOutParameter not implemented");
}
/**
* Registers the OUT parameter named
* <code>parameterName to the JDBC type
* {@code sqlType}. All OUT parameters must be registered
* before a stored procedure is executed.
* <p>
* The JDBC type specified by {@code sqlType} for an OUT
* parameter determines the Java type that must be used
* in the {@code get} method to read the value of that parameter.
* <p>
* If the JDBC type expected to be returned to this output parameter
* is specific to this particular database, {@code sqlType}
* should be {@code JDBCType.OTHER} or a {@code SQLType} that is supported
* by the JDBC driver.. The method
* {@link #getObject} retrieves the value.
*<P>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param parameterName the name of the parameter
* @param sqlType the JDBC type code defined by {@code SQLType} to use to
* register the OUT Parameter.
* If the parameter is of JDBC type {@code JDBCType.NUMERIC}
* or {@code JDBCType.DECIMAL}, the version of
* {@code registerOutParameter} that accepts a scale value
* should be used.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified sqlType
* or if the JDBC driver does not support
* this method
* @since 1.8
* @see JDBCType
* @see SQLType
*/
default void registerOutParameter(String parameterName, SQLType sqlType)
throws SQLException {
throw new SQLFeatureNotSupportedException("registerOutParameter not implemented");
}
/**
* Registers the parameter named
* <code>parameterName to be of JDBC type
* {@code sqlType}. All OUT parameters must be registered
* before a stored procedure is executed.
* <p>
* The JDBC type specified by {@code sqlType} for an OUT
* parameter determines the Java type that must be used
* in the {@code get} method to read the value of that parameter.
* <p>
* This version of {@code registerOutParameter} should be
* used when the parameter is of JDBC type {@code JDBCType.NUMERIC}
* or {@code JDBCType.DECIMAL}.
*<P>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param parameterName the name of the parameter
* @param sqlType the JDBC type code defined by {@code SQLType} to use to
* register the OUT Parameter.
* @param scale the desired number of digits to the right of the
* decimal point. It must be greater than or equal to zero.
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified sqlType
* or if the JDBC driver does not support
* this method
* @since 1.8
* @see JDBCType
* @see SQLType
*/
default void registerOutParameter(String parameterName, SQLType sqlType,
int scale) throws SQLException {
throw new SQLFeatureNotSupportedException("registerOutParameter not implemented");
}
/**
* Registers the designated output parameter. This version of
* the method {@code registerOutParameter}
* should be used for a user-named or REF output parameter. Examples
* of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and
* named array types.
*<p>
* All OUT parameters must be registered
* before a stored procedure is executed.
* </p>
* 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.
*
* <P>Note: When reading the value of an out parameter, you
* must use the {@code getXXX} method whose Java type XXX corresponds to the
* parameter's registered SQL type.
*<P>
* The default implementation will throw {@code SQLFeatureNotSupportedException}
*
* @param parameterName the name of the parameter
* @param sqlType the JDBC type code defined by {@code SQLType} to use to
* register the OUT Parameter.
* @param typeName the fully-qualified name of an SQL structured type
* @exception SQLException if parameterName does not correspond to a named
* parameter; if a database access error occurs or
* this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if
* the JDBC driver does not support the specified sqlType
* or if the JDBC driver does not support this method
* @see JDBCType
* @see SQLType
* @since 1.8
*/
default void registerOutParameter (String parameterName, SQLType sqlType,
String typeName) throws SQLException {
throw new SQLFeatureNotSupportedException("registerOutParameter not implemented");
}
}
Other Java examples (source code examples)
Here is a short list of links related to this Java CallableStatement.java source code file:
|
The search page
Other Java source code examples at this package level
Click here to learn more about this project
