/* * @(#)CallableStatement.java 1.47 04/05/18 * * Copyright 2004 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package java.sql; import java.math.BigDecimal; import java.util.Calendar; /** * The interface used to execute SQL stored procedures. The JDBC API * provides a stored procedure SQL escape syntax that allows stored procedures * to be called in a standard way for all RDBMSs. This escape syntax has one * form that includes a result parameter and one that does not. If used, the result * parameter must be registered as an OUT parameter. The other parameters * can be used for input, output or both. Parameters are referred to * sequentially, by number, with the first parameter being 1. * 
 *   {?= call <procedure-name>[<arg1>,<arg2>, ...]}
 *   {call <procedure-name>[<arg1>,<arg2>, ...]}
 *
*

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

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

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

* * @see Connection#prepareCall * @see ResultSet */ public interface CallableStatement extends PreparedStatement { /** * Registers the OUT parameter in ordinal position * parameterIndex to the JDBC type * sqlType. All OUT parameters must be registered * before a stored procedure is executed. *

* The JDBC type specified by sqlType for an OUT * parameter determines the Java type that must be used * in the get method to read the value of that parameter. *

* If the JDBC type expected to be returned to this output parameter * is specific to this particular database, sqlType * should be java.sql.Types.OTHER. The method * {@link #getObject} retrieves the value. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param sqlType the JDBC type code defined by java.sql.Types. * If the parameter is of JDBC type NUMERIC * or DECIMAL, the version of * registerOutParameter that accepts a scale value * should be used. * * @exception SQLException if a database access error occurs * @see Types */ void registerOutParameter(int parameterIndex, int sqlType) throws SQLException; /** * Registers the parameter in ordinal position * parameterIndex to be of JDBC type * sqlType. This method must be called * before a stored procedure is executed. *

* The JDBC type specified by sqlType for an OUT * parameter determines the Java type that must be used * in the get method to read the value of that parameter. *

* This version of registerOutParameter should be * used when the parameter is of JDBC type NUMERIC * or DECIMAL. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param sqlType the SQL type code defined by java.sql.Types. * @param scale the desired number of digits to the right of the * decimal point. It must be greater than or equal to zero. * @exception SQLException if a database access error occurs * @see Types */ void registerOutParameter(int parameterIndex, int sqlType, int scale) throws SQLException; /** * Retrieves whether the last OUT parameter read had the value of * SQL NULL. Note that this method should be called only after * calling a getter method; otherwise, there is no value to use in * determining whether it is null or not. * * @return true if the last parameter read was SQL * NULL; false otherwise * @exception SQLException if a database access error occurs */ boolean wasNull() throws SQLException; /** * Retrieves the value of the designated JDBC CHAR, * VARCHAR, or LONGVARCHAR parameter as a * String in the Java programming language. *

* For the fixed-length type JDBC CHAR, * the String object * returned has exactly the same value the JDBC * CHAR value had in the * database, including any padding added by the database. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result * is null. * @exception SQLException if a database access error occurs * @see #setString */ String getString(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC BIT parameter as a * boolean in the Java programming language. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, * the result is false. * @exception SQLException if a database access error occurs * @see #setBoolean */ boolean getBoolean(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC TINYINT parameter * as a byte in the Java programming language. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the result * is 0. * @exception SQLException if a database access error occurs * @see #setByte */ byte getByte(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC SMALLINT parameter * as a short in the Java programming language. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the result * is 0. * @exception SQLException if a database access error occurs * @see #setShort */ short getShort(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC INTEGER parameter * as an int in the Java programming language. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the result * is 0. * @exception SQLException if a database access error occurs * @see #setInt */ int getInt(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC BIGINT parameter * as a long in the Java programming language. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the result * is 0. * @exception SQLException if a database access error occurs * @see #setLong */ long getLong(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC FLOAT parameter * as a float in the Java programming language. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the result * is 0. * @exception SQLException if a database access error occurs * @see #setFloat */ float getFloat(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC DOUBLE parameter as a double * in the Java programming language. * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the result * is 0. * @exception SQLException if a database access error occurs * @see #setDouble */ double getDouble(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC NUMERIC parameter as a * java.math.BigDecimal object with scale digits to * the right of the decimal point. * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param scale the number of digits to the right of the decimal point * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @deprecated use getBigDecimal(int parameterIndex) * or getBigDecimal(String parameterName) * @see #setBigDecimal */ @Deprecated BigDecimal getBigDecimal(int parameterIndex, int scale) throws SQLException; /** * Retrieves the value of the designated JDBC BINARY or * VARBINARY parameter as an array of byte * values in the Java programming language. * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @see #setBytes */ byte[] getBytes(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC DATE parameter as a * java.sql.Date object. * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @see #setDate */ java.sql.Date getDate(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC TIME parameter as a * java.sql.Time object. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @see #setTime */ java.sql.Time getTime(int parameterIndex) throws SQLException; /** * Retrieves the value of the designated JDBC TIMESTAMP parameter as a * java.sql.Timestamp object. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @see #setTimestamp */ java.sql.Timestamp getTimestamp(int parameterIndex) throws SQLException; //---------------------------------------------------------------------- // Advanced features: /** * Retrieves the value of the designated parameter as an Object * in the Java programming language. If the value is an SQL NULL, * the driver returns a Java null. *

* This method returns a Java object whose type corresponds to the JDBC * type that was registered for this parameter using the method * registerOutParameter. By registering the target JDBC * type as java.sql.Types.OTHER, this method can be used * to read database-specific abstract data types. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return A java.lang.Object holding the OUT parameter value * @exception SQLException if a database access error occurs * @see Types * @see #setObject */ Object getObject(int parameterIndex) throws SQLException; //--------------------------JDBC 2.0----------------------------- /** * Retrieves the value of the designated JDBC NUMERIC parameter as a * java.math.BigDecimal object with as many digits to the * right of the decimal point as the value contains. * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @return the parameter value in full precision. If the value is * SQL NULL, the result is null. * @exception SQLException if a database access error occurs * @see #setBigDecimal * @since 1.2 */ BigDecimal getBigDecimal(int parameterIndex) throws SQLException; /** * Returns an object representing the value of OUT parameter * i and uses map for the custom * mapping of the parameter value. *

* This method returns a Java object whose type corresponds to the * JDBC type that was registered for this parameter using the method * registerOutParameter. By registering the target * JDBC type as java.sql.Types.OTHER, this method can * be used to read database-specific abstract data types. * @param i the first parameter is 1, the second is 2, and so on * @param map the mapping from SQL type names to Java classes * @return a java.lang.Object holding the OUT parameter value * @exception SQLException if a database access error occurs * @see #setObject * @since 1.2 */ Object getObject(int i, java.util.Map> map) throws SQLException; /** * Retrieves the value of the designated JDBC REF(<structured-type>) * parameter as a {@link Ref} object in the Java programming language. * @param i the first parameter is 1, the second is 2, * and so on * @return the parameter value as a Ref object in the * Java programming language. If the value was SQL NULL, the value * null is returned. * @exception SQLException if a database access error occurs * @since 1.2 */ Ref getRef (int i) throws SQLException; /** * Retrieves the value of the designated JDBC BLOB parameter as a * {@link Blob} object in the Java programming language. * @param i the first parameter is 1, the second is 2, and so on * @return the parameter value as a Blob object in the * Java programming language. If the value was SQL NULL, the value * null is returned. * @exception SQLException if a database access error occurs * @since 1.2 */ Blob getBlob (int i) throws SQLException; /** * Retrieves the value of the designated JDBC CLOB parameter as a * Clob object in the Java programming language. * @param i the first parameter is 1, the second is 2, and * so on * @return the parameter value as a Clob object in the * Java programming language. If the value was SQL NULL, the * value null is returned. * @exception SQLException if a database access error occurs * @since 1.2 */ Clob getClob (int i) throws SQLException; /** * * Retrieves the value of the designated JDBC ARRAY parameter as an * {@link Array} object in the Java programming language. * @param i the first parameter is 1, the second is 2, and * so on * @return the parameter value as an Array object in * the Java programming language. If the value was SQL NULL, the * value null is returned. * @exception SQLException if a database access error occurs * @since 1.2 */ Array getArray (int i) throws SQLException; /** * Retrieves the value of the designated JDBC DATE parameter as a * java.sql.Date object, using * the given Calendar object * to construct the date. * With a Calendar object, the driver * can calculate the date taking into account a custom timezone and locale. * If no Calendar object is specified, the driver uses the * default timezone and locale. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param cal the Calendar object the driver will use * to construct the date * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @see #setDate * @since 1.2 */ java.sql.Date getDate(int parameterIndex, Calendar cal) throws SQLException; /** * Retrieves the value of the designated JDBC TIME parameter as a * java.sql.Time object, using * the given Calendar object * to construct the time. * With a Calendar object, the driver * can calculate the time taking into account a custom timezone and locale. * If no Calendar object is specified, the driver uses the * default timezone and locale. * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param cal the Calendar object the driver will use * to construct the time * @return the parameter value; if the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @see #setTime * @since 1.2 */ java.sql.Time getTime(int parameterIndex, Calendar cal) throws SQLException; /** * Retrieves the value of the designated JDBC TIMESTAMP parameter as a * java.sql.Timestamp object, using * the given Calendar object to construct * the Timestamp object. * With a Calendar object, the driver * can calculate the timestamp taking into account a custom timezone and locale. * If no Calendar object is specified, the driver uses the * default timezone and locale. * * * @param parameterIndex the first parameter is 1, the second is 2, * and so on * @param cal the Calendar object the driver will use * to construct the timestamp * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @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 registerOutParameter * should be used for a user-defined or REF output parameter. Examples * of user-defined types include: STRUCT, DISTINCT, * JAVA_OBJECT, and named array types. * * Before executing a stored procedure call, you must explicitly * call registerOutParameter to register the type from * java.sql.Types for each * OUT parameter. For a user-defined parameter, the fully-qualified SQL * type name of the parameter should also be given, while a REF * parameter requires that the fully-qualified type name of the * referenced type be given. A JDBC driver that does not need the * type code and type name information may ignore it. To be portable, * however, applications should always provide these values for * user-defined and REF parameters. * * Although it is intended for user-defined and REF parameters, * this method may be used to register a parameter of any JDBC type. * If the parameter does not have a user-defined or REF type, the * typeName parameter is ignored. * *

Note: When reading the value of an out parameter, you * must use the getter method whose Java type corresponds to the * parameter's registered SQL type. * * @param paramIndex 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 a database access error occurs * @see Types * @since 1.2 */ void registerOutParameter (int paramIndex, int sqlType, String typeName) throws SQLException; //--------------------------JDBC 3.0----------------------------- /** * Registers the OUT parameter named * parameterName to the JDBC type * sqlType. All OUT parameters must be registered * before a stored procedure is executed. *

* The JDBC type specified by sqlType for an OUT * parameter determines the Java type that must be used * in the get method to read the value of that parameter. *

* If the JDBC type expected to be returned to this output parameter * is specific to this particular database, sqlType * should be java.sql.Types.OTHER. The method * {@link #getObject} retrieves the value. * @param parameterName the name of the parameter * @param sqlType the JDBC type code defined by java.sql.Types. * If the parameter is of JDBC type NUMERIC * or DECIMAL, the version of * registerOutParameter that accepts a scale value * should be used. * @exception SQLException if a database access error occurs * @since 1.4 * @see Types */ void registerOutParameter(String parameterName, int sqlType) throws SQLException; /** * Registers the parameter named * parameterName to be of JDBC type * sqlType. This method must be called * before a stored procedure is executed. *

* The JDBC type specified by sqlType for an OUT * parameter determines the Java type that must be used * in the get method to read the value of that parameter. *

* This version of registerOutParameter should be * used when the parameter is of JDBC type NUMERIC * or DECIMAL. * @param parameterName the name of the parameter * @param sqlType SQL type code defined by java.sql.Types. * @param scale the desired number of digits to the right of the * decimal point. It must be greater than or equal to zero. * @exception SQLException if a database access error occurs * @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 registerOutParameter * should be used for a user-named or REF output parameter. Examples * of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and * named array types. * * Before executing a stored procedure call, you must explicitly * call registerOutParameter to register the type from * java.sql.Types for each * OUT parameter. For a user-named parameter the fully-qualified SQL * type name of the parameter should also be given, while a REF * parameter requires that the fully-qualified type name of the * referenced type be given. A JDBC driver that does not need the * type code and type name information may ignore it. To be portable, * however, applications should always provide these values for * user-named and REF parameters. * * Although it is intended for user-named and REF parameters, * this method may be used to register a parameter of any JDBC type. * If the parameter does not have a user-named or REF type, the * typeName parameter is ignored. * *

Note: When reading the value of an out parameter, you * must use the getXXX method whose Java type XXX corresponds to the * parameter's registered SQL type. * * @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 a database access error occurs * @see Types * @since 1.4 */ void registerOutParameter (String parameterName, int sqlType, String typeName) throws SQLException; /** * Retrieves the value of the designated JDBC DATALINK parameter as a * java.net.URL object. * * @param parameterIndex the first parameter is 1, the second is 2,... * @return a java.net.URL object that represents the * JDBC DATALINK value used as the designated * parameter * @exception SQLException if a database access error occurs, * or if the URL being returned is * not a valid URL on the Java platform * @see #setURL * @since 1.4 */ java.net.URL getURL(int parameterIndex) throws SQLException; /** * Sets the designated parameter to the given java.net.URL object. * The driver converts this to an SQL DATALINK value when * it sends it to the database. * * @param parameterName the name of the parameter * @param val the parameter value * @exception SQLException if a database access error occurs, * or if a URL is malformed * @see #getURL * @since 1.4 */ void setURL(String parameterName, java.net.URL val) throws SQLException; /** * Sets the designated parameter to SQL NULL. * *

Note: You must specify the parameter's SQL type. * * @param parameterName the name of the parameter * @param sqlType the SQL type code defined in java.sql.Types * @exception SQLException if a database access error occurs * @since 1.4 */ void setNull(String parameterName, int sqlType) throws SQLException; /** * Sets the designated parameter to the given Java boolean value. * The driver converts this * to an SQL BIT value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getBoolean * @since 1.4 */ void setBoolean(String parameterName, boolean x) throws SQLException; /** * Sets the designated parameter to the given Java byte value. * The driver converts this * to an SQL TINYINT value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getByte * @since 1.4 */ void setByte(String parameterName, byte x) throws SQLException; /** * Sets the designated parameter to the given Java short value. * The driver converts this * to an SQL SMALLINT value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getShort * @since 1.4 */ void setShort(String parameterName, short x) throws SQLException; /** * Sets the designated parameter to the given Java int value. * The driver converts this * to an SQL INTEGER value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getInt * @since 1.4 */ void setInt(String parameterName, int x) throws SQLException; /** * Sets the designated parameter to the given Java long value. * The driver converts this * to an SQL BIGINT value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getLong * @since 1.4 */ void setLong(String parameterName, long x) throws SQLException; /** * Sets the designated parameter to the given Java float value. * The driver converts this * to an SQL FLOAT value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getFloat * @since 1.4 */ void setFloat(String parameterName, float x) throws SQLException; /** * Sets the designated parameter to the given Java double value. * The driver converts this * to an SQL DOUBLE value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getDouble * @since 1.4 */ void setDouble(String parameterName, double x) throws SQLException; /** * Sets the designated parameter to the given * java.math.BigDecimal value. * The driver converts this to an SQL NUMERIC value when * it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getBigDecimal * @since 1.4 */ void setBigDecimal(String parameterName, BigDecimal x) throws SQLException; /** * Sets the designated parameter to the given Java String value. * The driver converts this * to an SQL VARCHAR or LONGVARCHAR value * (depending on the argument's * size relative to the driver's limits on VARCHAR values) * when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @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 VARBINARY or * LONGVARBINARY (depending on the argument's size relative * to the driver's limits on VARBINARY values) when it sends * it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getBytes * @since 1.4 */ void setBytes(String parameterName, byte x[]) throws SQLException; /** * Sets the designated parameter to the given java.sql.Date value. * The driver converts this * to an SQL DATE value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getDate * @since 1.4 */ void setDate(String parameterName, java.sql.Date x) throws SQLException; /** * Sets the designated parameter to the given java.sql.Time value. * The driver converts this * to an SQL TIME value when it sends it to the database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @see #getTime * @since 1.4 */ void setTime(String parameterName, java.sql.Time x) throws SQLException; /** * Sets the designated parameter to the given java.sql.Timestamp value. * The driver * converts this to an SQL TIMESTAMP value when it sends it to the * database. * * @param parameterName the name of the parameter * @param x the parameter value * @exception SQLException if a database access error occurs * @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 LONGVARCHAR * parameter, it may be more practical to send it via a * java.io.InputStream. Data will be read from the stream * as needed until end-of-file is reached. The JDBC driver will * do any necessary conversion from ASCII to the database char format. * *

Note: This stream object can either be a standard * Java stream object or your own subclass that implements the * standard interface. * * @param parameterName the name of the parameter * @param x the Java input stream that contains the ASCII parameter value * @param length the number of bytes in the stream * @exception SQLException if a database access error occurs * @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 LONGVARBINARY * parameter, it may be more practical to send it via a * java.io.InputStream object. The data will be read from the stream * as needed until end-of-file is reached. * *

Note: This stream object can either be a standard * Java stream object or your own subclass that implements the * standard interface. * * @param parameterName the name of the parameter * @param x the java input stream which contains the binary parameter value * @param length the number of bytes in the stream * @exception SQLException if a database access error occurs * @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. The second * argument must be an object type; for integral values, the * java.lang equivalent objects should be used. * *

The given Java object will be converted to the given targetSqlType * before being sent to the database. * * If the object has a custom mapping (is of a class implementing the * interface SQLData), * the JDBC driver should call the method SQLData.writeSQL to write it * to the SQL data stream. * If, on the other hand, the object is of a class implementing * Ref, Blob, Clob, Struct, * or Array, the driver should pass it to the database as a * value of the corresponding SQL type. *

* Note that this method may be used to pass datatabase- * specific abstract data types. * * @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 a database access error occurs * @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 like the method setObject * above, except that it assumes a scale of zero. * * @param parameterName the name of the parameter * @param x the object containing the input parameter value * @param targetSqlType the SQL type (as defined in java.sql.Types) to be * sent to the database * @exception SQLException if a database access error occurs * @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. * The second parameter must be of type Object; therefore, the * java.lang equivalent objects should be used for built-in types. * *

The JDBC specification specifies a standard mapping from * Java Object types to SQL types. The given argument * will be converted to the corresponding SQL type before being * sent to the database. * *

Note that this method may be used to pass datatabase- * specific abstract data types, by using a driver-specific Java * type. * * If the object is of a class implementing the interface SQLData, * the JDBC driver should call the method SQLData.writeSQL * to write it to the SQL data stream. * If, on the other hand, the object is of a class implementing * Ref, Blob, Clob, Struct, * or Array, the driver should pass it to the database as a * value of the corresponding SQL type. *

* This method throws an exception if there is an ambiguity, for example, if the * object is of a class implementing more than one of the interfaces named above. * * @param parameterName the name of the parameter * @param x the object containing the input parameter value * @exception SQLException if a database access error occurs or if the given * Object parameter is ambiguous * @see #getObject * @since 1.4 */ void setObject(String parameterName, Object x) throws SQLException; /** * Sets the designated parameter to the given Reader * object, which is the given number of characters long. * When a very large UNICODE value is input to a LONGVARCHAR * parameter, it may be more practical to send it via a * java.io.Reader object. The data will be read from the stream * as needed until end-of-file is reached. The JDBC driver will * do any necessary conversion from UNICODE to the database char format. * *

Note: This stream object can either be a standard * Java stream object or your own subclass that implements the * standard interface. * * @param parameterName the name of the parameter * @param reader the java.io.Reader object that * contains the UNICODE data used as the designated parameter * @param length the number of characters in the stream * @exception SQLException if a database access error occurs * @since 1.4 */ void setCharacterStream(String parameterName, java.io.Reader reader, int length) throws SQLException; /** * Sets the designated parameter to the given java.sql.Date value, * using the given Calendar object. The driver uses * the Calendar object to construct an SQL DATE value, * which the driver then sends to the database. With a * a Calendar object, the driver can calculate the date * taking into account a custom timezone. If no * Calendar object is specified, the driver uses the default * timezone, which is that of the virtual machine running the application. * * @param parameterName the name of the parameter * @param x the parameter value * @param cal the Calendar object the driver will use * to construct the date * @exception SQLException if a database access error occurs * @see #getDate * @since 1.4 */ void setDate(String parameterName, java.sql.Date x, Calendar cal) throws SQLException; /** * Sets the designated parameter to the given java.sql.Time value, * using the given Calendar object. The driver uses * the Calendar object to construct an SQL TIME value, * which the driver then sends to the database. With a * a Calendar object, the driver can calculate the time * taking into account a custom timezone. If no * Calendar object is specified, the driver uses the default * timezone, which is that of the virtual machine running the application. * * @param parameterName the name of the parameter * @param x the parameter value * @param cal the Calendar object the driver will use * to construct the time * @exception SQLException if a database access error occurs * @see #getTime * @since 1.4 */ void setTime(String parameterName, java.sql.Time x, Calendar cal) throws SQLException; /** * Sets the designated parameter to the given java.sql.Timestamp value, * using the given Calendar object. The driver uses * the Calendar object to construct an SQL TIMESTAMP value, * which the driver then sends to the database. With a * a Calendar object, the driver can calculate the timestamp * taking into account a custom timezone. If no * Calendar object is specified, the driver uses the default * timezone, which is that of the virtual machine running the application. * * @param parameterName the name of the parameter * @param x the parameter value * @param cal the Calendar object the driver will use * to construct the timestamp * @exception SQLException if a database access error occurs * @see #getTimestamp * @since 1.4 */ void setTimestamp(String parameterName, java.sql.Timestamp x, Calendar cal) throws SQLException; /** * Sets the designated parameter to SQL NULL. * This version of the method setNull should * be used for user-defined types and REF type parameters. Examples * of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and * named array types. * *

Note: To be portable, applications must give the * SQL type code and the fully-qualified SQL type name when specifying * a NULL user-defined or REF parameter. In the case of a user-defined type * the name is the type name of the parameter itself. For a REF * parameter, the name is the type name of the referenced type. If * a JDBC driver does not need the type code or type name information, * it may ignore it. * * Although it is intended for user-defined and Ref parameters, * this method may be used to set a null parameter of any JDBC type. * If the parameter does not have a user-defined or REF type, the given * typeName is ignored. * * * @param parameterName the name of the parameter * @param sqlType a value from java.sql.Types * @param typeName the fully-qualified name of an SQL user-defined type; * ignored if the parameter is not a user-defined type or * SQL REF value * @exception SQLException if a database access error occurs * @since 1.4 */ void setNull (String parameterName, int sqlType, String typeName) throws SQLException; /** * Retrieves the value of a JDBC CHAR, VARCHAR, * or LONGVARCHAR parameter as a String in * the Java programming language. *

* For the fixed-length type JDBC CHAR, * the String object * returned has exactly the same value the JDBC * CHAR value had in the * database, including any padding added by the database. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @see #setString * @since 1.4 */ String getString(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC BIT parameter as a * boolean in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, the result * is false. * @exception SQLException if a database access error occurs * @see #setBoolean * @since 1.4 */ boolean getBoolean(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC TINYINT parameter as a byte * in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, the result * is 0. * @exception SQLException if a database access error occurs * @see #setByte * @since 1.4 */ byte getByte(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC SMALLINT parameter as a short * in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, the result * is 0. * @exception SQLException if a database access error occurs * @see #setShort * @since 1.4 */ short getShort(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC INTEGER parameter as an int * in the Java programming language. * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setInt * @since 1.4 */ int getInt(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC BIGINT parameter as a long * in the Java programming language. * * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setLong * @since 1.4 */ long getLong(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC FLOAT parameter as a float * in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setFloat * @since 1.4 */ float getFloat(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC DOUBLE parameter as a double * in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, * the result is 0. * @exception SQLException if a database access error occurs * @see #setDouble * @since 1.4 */ double getDouble(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC BINARY or VARBINARY * parameter as an array of byte values in the Java * programming language. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, the result is * null. * @exception SQLException if a database access error occurs * @see #setBytes * @since 1.4 */ byte[] getBytes(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC DATE parameter as a * java.sql.Date object. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @see #setDate * @since 1.4 */ java.sql.Date getDate(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC TIME parameter as a * java.sql.Time object. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @see #setTime * @since 1.4 */ java.sql.Time getTime(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC TIMESTAMP parameter as a * java.sql.Timestamp object. * @param parameterName the name of the parameter * @return the parameter value. If the value is SQL NULL, the result * is null. * @exception SQLException if a database access error occurs * @see #setTimestamp * @since 1.4 */ java.sql.Timestamp getTimestamp(String parameterName) throws SQLException; /** * Retrieves the value of a parameter as an Object in the Java * programming language. If the value is an SQL NULL, the * driver returns a Java null. *

* This method returns a Java object whose type corresponds to the JDBC * type that was registered for this parameter using the method * registerOutParameter. By registering the target JDBC * type as java.sql.Types.OTHER, this method can be used * to read database-specific abstract data types. * @param parameterName the name of the parameter * @return A java.lang.Object holding the OUT parameter value. * @exception SQLException if a database access error occurs * @see Types * @see #setObject * @since 1.4 */ Object getObject(String parameterName) throws SQLException; /** * Retrieves the value of a JDBC NUMERIC parameter as a * java.math.BigDecimal object with as many digits to the * right of the decimal point as the value contains. * @param parameterName the name of the parameter * @return the parameter value in full precision. If the value is * SQL NULL, the result is null. * @exception SQLException if a database access error occurs * @see #setBigDecimal * @since 1.4 */ BigDecimal getBigDecimal(String parameterName) throws SQLException; /** * Returns an object representing the value of OUT parameter * i and uses map for the custom * mapping of the parameter value. *

* This method returns a Java object whose type corresponds to the * JDBC type that was registered for this parameter using the method * registerOutParameter. By registering the target * JDBC type as java.sql.Types.OTHER, this method can * be used to read database-specific abstract data types. * @param parameterName the name of the parameter * @param map the mapping from SQL type names to Java classes * @return a java.lang.Object holding the OUT parameter value * @exception SQLException if a database access error occurs * @see #setObject * @since 1.4 */ Object getObject(String parameterName, java.util.Map> map) throws SQLException; /** * Retrieves the value of a JDBC REF(<structured-type>) * parameter as a {@link Ref} object in the Java programming language. * * @param parameterName the name of the parameter * @return the parameter value as a Ref object in the * Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since 1.4 */ Ref getRef (String parameterName) throws SQLException; /** * Retrieves the value of a JDBC BLOB parameter as a * {@link Blob} object in the Java programming language. * * @param parameterName the name of the parameter * @return the parameter value as a Blob object in the * Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since 1.4 */ Blob getBlob (String parameterName) throws SQLException; /** * Retrieves the value of a JDBC CLOB parameter as a * Clob object in the Java programming language. * @param parameterName the name of the parameter * @return the parameter value as a Clob object in the * Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since 1.4 */ Clob getClob (String parameterName) throws SQLException; /** * Retrieves the value of a JDBC ARRAY parameter as an * {@link Array} object in the Java programming language. * * @param parameterName the name of the parameter * @return the parameter value as an Array object in * Java programming language. If the value was SQL NULL, * the value null is returned. * @exception SQLException if a database access error occurs * @since 1.4 */ Array getArray (String parameterName) throws SQLException; /** * Retrieves the value of a JDBC DATE parameter as a * java.sql.Date object, using * the given Calendar object * to construct the date. * With a Calendar object, the driver * can calculate the date taking into account a custom timezone and locale. * If no Calendar object is specified, the driver uses the * default timezone and locale. * * @param parameterName the name of the parameter * @param cal the Calendar object the driver will use * to construct the date * @return the parameter value. If the value is SQL NULL, * the result is null. * @exception SQLException if a database access error occurs * @see #setDate * @since 1.4 */ java.sql.Date getDate(String parameterName, Calendar cal) throws SQLException; /** * Retrieves the value of a JDBC TIME parameter as a * java.sql.Time object, using * the given Calendar object * to construct the time. * With a Calendar object, the driver * can calculate the time taking into account a custom timezone and locale. * If no Calendar object is specified, the driver uses the * default timezone and locale. * * @param parameterName the name of the parameter * @param cal the Calendar object the driver will use * to construct the time * @return the parameter value; if the value is SQL NULL, the result is * null. * @exception SQLException if a database access error occurs * @see #setTime * @since 1.4 */ java.sql.Time getTime(String parameterName, Calendar cal) throws SQLException; /** * Retrieves the value of a JDBC TIMESTAMP parameter as a * java.sql.Timestamp object, using * the given Calendar object to construct * the Timestamp object. * With a Calendar object, the driver * can calculate the timestamp taking into account a custom timezone and locale. * If no Calendar object is specified, the driver uses the * default timezone and locale. * * * @param parameterName the name of the parameter * @param cal the Calendar object the driver will use * to construct the timestamp * @return the parameter value. If the value is SQL NULL, the result is * null. * @exception SQLException if a database access error occurs * @see #setTimestamp * @since 1.4 */ java.sql.Timestamp getTimestamp(String parameterName, Calendar cal) throws SQLException; /** * Retrieves the value of a JDBC DATALINK parameter as a * java.net.URL object. * * @param parameterName the name of the parameter * @return the parameter value as a java.net.URL object in the * Java programming language. If the value was SQL NULL, the * value null is returned. * @exception SQLException if a database access error occurs, * or if there is a problem with the URL * @see #setURL * @since 1.4 */ java.net.URL getURL(String parameterName) throws SQLException; }