Added in API level 1

Summary: Inherited Constants | Methods | Inherited Methods

CallableStatement

public interface CallableStatement
implements PreparedStatement

java.sql.CallableStatement

The interface used to execute SQL stored procedures. The JDBC API provides a stored procedure SQL escape syntax that allows stored procedures to be called in a standard way for all RDBMSs. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters can be used for input, output or both. Parameters are referred to sequentially, by number, with the first parameter being 1.

   {?= call <procedure-name>[(<arg1>,<arg2>, ...)]}
   {call <procedure-name>[(<arg1>,<arg2>, ...)]}

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

A CallableStatement can return one ResultSet object or multiple ResultSet objects. Multiple ResultSet objects are handled using operations inherited from Statement.

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

See also:

Summary

Inherited constants

From interface java.sql.Statement

`int`	`CLOSE_ALL_RESULTS` The constant indicating that all `ResultSet` objects that have previously been kept open should be closed when calling `getMoreResults`.
`int`	`CLOSE_CURRENT_RESULT` The constant indicating that the current `ResultSet` object should be closed when calling `getMoreResults`.
`int`	`EXECUTE_FAILED` The constant indicating that an error occured while executing a batch statement.
`int`	`KEEP_CURRENT_RESULT` The constant indicating that the current `ResultSet` object should not be closed when calling `getMoreResults`.
`int`	`NO_GENERATED_KEYS` The constant indicating that generated keys should not be made available for retrieval.
`int`	`RETURN_GENERATED_KEYS` The constant indicating that generated keys should be made available for retrieval.
`int`	`SUCCESS_NO_INFO` The constant indicating that a batch statement executed successfully but that no count of the number of rows it affected is available.

Public methods
`abstract Array`	`getArray(int parameterIndex)` Retrieves the value of the designated JDBC `ARRAY` parameter as an `Array` object in the Java programming language.
`abstract Array`	`getArray(String parameterName)` Retrieves the value of a JDBC `ARRAY` parameter as an `Array` object in the Java programming language.
`abstract BigDecimal`	`getBigDecimal(String parameterName)` Retrieves the value of a JDBC `NUMERIC` parameter as a `java.math.BigDecimal` object with as many digits to the right of the decimal point as the value contains.
`abstract BigDecimal`	`getBigDecimal(int parameterIndex, int scale)` This method was deprecated in API level 15. use `getBigDecimal(int parameterIndex)` or `getBigDecimal(String parameterName)`
`abstract BigDecimal`	`getBigDecimal(int parameterIndex)` Retrieves the value of the designated JDBC `NUMERIC` parameter as a `java.math.BigDecimal` object with as many digits to the right of the decimal point as the value contains.
`abstract Blob`	`getBlob(int parameterIndex)` Retrieves the value of the designated JDBC `BLOB` parameter as a `Blob` object in the Java programming language.
`abstract Blob`	`getBlob(String parameterName)` Retrieves the value of a JDBC `BLOB` parameter as a `Blob` object in the Java programming language.
`abstract boolean`	`getBoolean(String parameterName)` Retrieves the value of a JDBC `BIT` or `BOOLEAN` parameter as a `boolean` in the Java programming language.
`abstract boolean`	`getBoolean(int parameterIndex)` Retrieves the value of the designated JDBC `BIT` or `BOOLEAN` parameter as a `boolean` in the Java programming language.
`abstract byte`	`getByte(String parameterName)` Retrieves the value of a JDBC `TINYINT` parameter as a `byte` in the Java programming language.
`abstract byte`	`getByte(int parameterIndex)` Retrieves the value of the designated JDBC `TINYINT` parameter as a `byte` in the Java programming language.
`abstract byte[]`	`getBytes(String parameterName)` Retrieves the value of a JDBC `BINARY` or `VARBINARY` parameter as an array of `byte` values in the Java programming language.
`abstract byte[]`	`getBytes(int parameterIndex)` Retrieves the value of the designated JDBC `BINARY` or `VARBINARY` parameter as an array of `byte` values in the Java programming language.
`abstract Reader`	`getCharacterStream(int parameterIndex)` Retrieves the value of the designated parameter as a `java.io.Reader` object in the Java programming language.
`abstract Reader`	`getCharacterStream(String parameterName)` Retrieves the value of the designated parameter as a `java.io.Reader` object in the Java programming language.
`abstract Clob`	`getClob(int parameterIndex)` Retrieves the value of the designated JDBC `CLOB` parameter as a `java.sql.Clob` object in the Java programming language.
`abstract Clob`	`getClob(String parameterName)` Retrieves the value of a JDBC `CLOB` parameter as a `java.sql.Clob` object in the Java programming language.
`abstract Date`	`getDate(int parameterIndex)` Retrieves the value of the designated JDBC `DATE` parameter as a `java.sql.Date` object.
`abstract Date`	`getDate(String parameterName)` Retrieves the value of a JDBC `DATE` parameter as a `java.sql.Date` object.
`abstract Date`	`getDate(String parameterName, Calendar cal)` Retrieves the value of a JDBC `DATE` parameter as a `java.sql.Date` object, using the given `Calendar` object to construct the date.
`abstract Date`	`getDate(int parameterIndex, Calendar cal)` Retrieves the value of the designated JDBC `DATE` parameter as a `java.sql.Date` object, using the given `Calendar` object to construct the date.
`abstract double`	`getDouble(int parameterIndex)` Retrieves the value of the designated JDBC `DOUBLE` parameter as a `double` in the Java programming language.
`abstract double`	`getDouble(String parameterName)` Retrieves the value of a JDBC `DOUBLE` parameter as a `double` in the Java programming language.
`abstract float`	`getFloat(String parameterName)` Retrieves the value of a JDBC `FLOAT` parameter as a `float` in the Java programming language.
`abstract float`	`getFloat(int parameterIndex)` Retrieves the value of the designated JDBC `FLOAT` parameter as a `float` in the Java programming language.
`abstract int`	`getInt(int parameterIndex)` Retrieves the value of the designated JDBC `INTEGER` parameter as an `int` in the Java programming language.
`abstract int`	`getInt(String parameterName)` Retrieves the value of a JDBC `INTEGER` parameter as an `int` in the Java programming language.
`abstract long`	`getLong(String parameterName)` Retrieves the value of a JDBC `BIGINT` parameter as a `long` in the Java programming language.
`abstract long`	`getLong(int parameterIndex)` Retrieves the value of the designated JDBC `BIGINT` parameter as a `long` in the Java programming language.
`abstract Reader`	`getNCharacterStream(int parameterIndex)` Retrieves the value of the designated parameter as a `java.io.Reader` object in the Java programming language.
`abstract Reader`	`getNCharacterStream(String parameterName)` Retrieves the value of the designated parameter as a `java.io.Reader` object in the Java programming language.
`abstract NClob`	`getNClob(String parameterName)` Retrieves the value of a JDBC `NCLOB` parameter as a `java.sql.NClob` object in the Java programming language.
`abstract NClob`	`getNClob(int parameterIndex)` Retrieves the value of the designated JDBC `NCLOB` parameter as a `java.sql.NClob` object in the Java programming language.
`abstract String`	`getNString(String parameterName)` Retrieves the value of the designated `NCHAR`, `NVARCHAR` or `LONGNVARCHAR` parameter as a `String` in the Java programming language.
`abstract String`	`getNString(int parameterIndex)` Retrieves the value of the designated `NCHAR`, `NVARCHAR` or `LONGNVARCHAR` parameter as a `String` in the Java programming language.
`abstract Object`	`getObject(String parameterName, Map<String, Class<?>> map)` Returns an object representing the value of OUT parameter `parameterName` and uses `map` for the custom mapping of the parameter value.
`abstract Object`	`getObject(int parameterIndex, Map<String, Class<?>> map)` Returns an object representing the value of OUT parameter `parameterIndex` and uses `map` for the custom mapping of the parameter value.
`abstract Object`	`getObject(int parameterIndex)` Retrieves the value of the designated parameter as an `Object` in the Java programming language.
`abstract Object`	`getObject(String parameterName)` Retrieves the value of a parameter as an `Object` in the Java programming language.
`abstract Ref`	`getRef(int parameterIndex)` Retrieves the value of the designated JDBC `REF(<structured-type>)` parameter as a `Ref` object in the Java programming language.
`abstract Ref`	`getRef(String parameterName)` Retrieves the value of a JDBC `REF(<structured-type>)` parameter as a `Ref` object in the Java programming language.
`abstract RowId`	`getRowId(int parameterIndex)` Retrieves the value of the designated JDBC `ROWID` parameter as a `java.sql.RowId` object.
`abstract RowId`	`getRowId(String parameterName)` Retrieves the value of the designated JDBC `ROWID` parameter as a `java.sql.RowId` object.
`abstract SQLXML`	`getSQLXML(String parameterName)` Retrieves the value of the designated `SQL XML` parameter as a `java.sql.SQLXML` object in the Java programming language.
`abstract SQLXML`	`getSQLXML(int parameterIndex)` Retrieves the value of the designated `SQL XML` parameter as a `java.sql.SQLXML` object in the Java programming language.
`abstract short`	`getShort(String parameterName)` Retrieves the value of a JDBC `SMALLINT` parameter as a `short` in the Java programming language.
`abstract short`	`getShort(int parameterIndex)` Retrieves the value of the designated JDBC `SMALLINT` parameter as a `short` in the Java programming language.
`abstract String`	`getString(int parameterIndex)` Retrieves the value of the designated JDBC `CHAR`, `VARCHAR`, or `LONGVARCHAR` parameter as a `String` in the Java programming language.
`abstract String`	`getString(String parameterName)` Retrieves the value of a JDBC `CHAR`, `VARCHAR`, or `LONGVARCHAR` parameter as a `String` in the Java programming language.
`abstract Time`	`getTime(String parameterName)` Retrieves the value of a JDBC `TIME` parameter as a `java.sql.Time` object.
`abstract Time`	`getTime(String parameterName, Calendar cal)` Retrieves the value of a JDBC `TIME` parameter as a `java.sql.Time` object, using the given `Calendar` object to construct the time.
`abstract Time`	`getTime(int parameterIndex)` Retrieves the value of the designated JDBC `TIME` parameter as a `java.sql.Time` object.
`abstract Time`	`getTime(int parameterIndex, Calendar cal)` Retrieves the value of the designated JDBC `TIME` parameter as a `java.sql.Time` object, using the given `Calendar` object to construct the time.
`abstract Timestamp`	`getTimestamp(int parameterIndex, Calendar cal)` 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.
`abstract Timestamp`	`getTimestamp(int parameterIndex)` Retrieves the value of the designated JDBC `TIMESTAMP` parameter as a `java.sql.Timestamp` object.
`abstract Timestamp`	`getTimestamp(String parameterName, Calendar cal)` Retrieves the value of a JDBC `TIMESTAMP` parameter as a `java.sql.Timestamp` object, using the given `Calendar` object to construct the `Timestamp` object.
`abstract Timestamp`	`getTimestamp(String parameterName)` Retrieves the value of a JDBC `TIMESTAMP` parameter as a `java.sql.Timestamp` object.
`abstract URL`	`getURL(int parameterIndex)` Retrieves the value of the designated JDBC `DATALINK` parameter as a `java.net.URL` object.
`abstract URL`	`getURL(String parameterName)` Retrieves the value of a JDBC `DATALINK` parameter as a `java.net.URL` object.
`abstract void`	`registerOutParameter(int parameterIndex, int sqlType)` Registers the OUT parameter in ordinal position `parameterIndex` to the JDBC type `sqlType`.
`abstract void`	`registerOutParameter(String parameterName, int sqlType, String typeName)` Registers the designated output parameter.
`abstract void`	`registerOutParameter(int parameterIndex, int sqlType, String typeName)` Registers the designated output parameter.
`abstract void`	`registerOutParameter(int parameterIndex, int sqlType, int scale)` Registers the parameter in ordinal position `parameterIndex` to be of JDBC type `sqlType`.
`abstract void`	`registerOutParameter(String parameterName, int sqlType, int scale)` Registers the parameter named `parameterName` to be of JDBC type `sqlType`.
`abstract void`	`registerOutParameter(String parameterName, int sqlType)` Registers the OUT parameter named `parameterName` to the JDBC type `sqlType`.
`abstract void`	`setAsciiStream(String parameterName, InputStream x, int length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`abstract void`	`setAsciiStream(String parameterName, InputStream x, long length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`abstract void`	`setAsciiStream(String parameterName, InputStream x)` Sets the designated parameter to the given input stream.
`abstract void`	`setBigDecimal(String parameterName, BigDecimal x)` Sets the designated parameter to the given `java.math.BigDecimal` value.
`abstract void`	`setBinaryStream(String parameterName, InputStream x)` Sets the designated parameter to the given input stream.
`abstract void`	`setBinaryStream(String parameterName, InputStream x, long length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`abstract void`	`setBinaryStream(String parameterName, InputStream x, int length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`abstract void`	`setBlob(String parameterName, Blob x)` Sets the designated parameter to the given `java.sql.Blob` object.
`abstract void`	`setBlob(String parameterName, InputStream inputStream, long length)` Sets the designated parameter to a `InputStream` object.
`abstract void`	`setBlob(String parameterName, InputStream inputStream)` Sets the designated parameter to a `InputStream` object.
`abstract void`	`setBoolean(String parameterName, boolean x)` Sets the designated parameter to the given Java `boolean` value.
`abstract void`	`setByte(String parameterName, byte x)` Sets the designated parameter to the given Java `byte` value.
`abstract void`	`setBytes(String parameterName, byte[] x)` Sets the designated parameter to the given Java array of bytes.
`abstract void`	`setCharacterStream(String parameterName, Reader reader, int length)` Sets the designated parameter to the given `Reader` object, which is the given number of characters long.
`abstract void`	`setCharacterStream(String parameterName, Reader reader, long length)` Sets the designated parameter to the given `Reader` object, which is the given number of characters long.
`abstract void`	`setCharacterStream(String parameterName, Reader reader)` Sets the designated parameter to the given `Reader` object.
`abstract void`	`setClob(String parameterName, Clob x)` Sets the designated parameter to the given `java.sql.Clob` object.
`abstract void`	`setClob(String parameterName, Reader reader, long length)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setClob(String parameterName, Reader reader)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setDate(String parameterName, Date x, Calendar cal)` Sets the designated parameter to the given `java.sql.Date` value, using the given `Calendar` object.
`abstract void`	`setDate(String parameterName, Date x)` Sets the designated parameter to the given `java.sql.Date` value using the default time zone of the virtual machine that is running the application.
`abstract void`	`setDouble(String parameterName, double x)` Sets the designated parameter to the given Java `double` value.
`abstract void`	`setFloat(String parameterName, float x)` Sets the designated parameter to the given Java `float` value.
`abstract void`	`setInt(String parameterName, int x)` Sets the designated parameter to the given Java `int` value.
`abstract void`	`setLong(String parameterName, long x)` Sets the designated parameter to the given Java `long` value.
`abstract void`	`setNCharacterStream(String parameterName, Reader value, long length)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setNCharacterStream(String parameterName, Reader value)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setNClob(String parameterName, Reader reader, long length)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setNClob(String parameterName, NClob value)` Sets the designated parameter to a `java.sql.NClob` object.
`abstract void`	`setNClob(String parameterName, Reader reader)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setNString(String parameterName, String value)` Sets the designated parameter to the given `String` object.
`abstract void`	`setNull(String parameterName, int sqlType)` Sets the designated parameter to SQL `NULL`.
`abstract void`	`setNull(String parameterName, int sqlType, String typeName)` Sets the designated parameter to SQL `NULL`.
`abstract void`	`setObject(String parameterName, Object x, int targetSqlType, int scale)` Sets the value of the designated parameter with the given object.
`abstract void`	`setObject(String parameterName, Object x, int targetSqlType)` Sets the value of the designated parameter with the given object.
`abstract void`	`setObject(String parameterName, Object x)` Sets the value of the designated parameter with the given object.
`abstract void`	`setRowId(String parameterName, RowId x)` Sets the designated parameter to the given `java.sql.RowId` object.
`abstract void`	`setSQLXML(String parameterName, SQLXML xmlObject)` Sets the designated parameter to the given `java.sql.SQLXML` object.
`abstract void`	`setShort(String parameterName, short x)` Sets the designated parameter to the given Java `short` value.
`abstract void`	`setString(String parameterName, String x)` Sets the designated parameter to the given Java `String` value.
`abstract void`	`setTime(String parameterName, Time x, Calendar cal)` Sets the designated parameter to the given `java.sql.Time` value, using the given `Calendar` object.
`abstract void`	`setTime(String parameterName, Time x)` Sets the designated parameter to the given `java.sql.Time` value.
`abstract void`	`setTimestamp(String parameterName, Timestamp x, Calendar cal)` Sets the designated parameter to the given `java.sql.Timestamp` value, using the given `Calendar` object.
`abstract void`	`setTimestamp(String parameterName, Timestamp x)` Sets the designated parameter to the given `java.sql.Timestamp` value.
`abstract void`	`setURL(String parameterName, URL val)` Sets the designated parameter to the given `java.net.URL` object.
`abstract boolean`	`wasNull()` Retrieves whether the last OUT parameter read had the value of SQL `NULL`.

Inherited methods

From interface


        
          java.sql.PreparedStatement

`abstract void`	`addBatch()` Adds a set of parameters to this `PreparedStatement` object's batch of commands.
`abstract void`	`clearParameters()` Clears the current parameter values immediately.
`abstract boolean`	`execute()` Executes the SQL statement in this `PreparedStatement` object, which may be any kind of SQL statement.
`abstract ResultSet`	`executeQuery()` Executes the SQL query in this `PreparedStatement` object and returns the `ResultSet` object generated by the query.
`abstract int`	`executeUpdate()` Executes the SQL statement in this `PreparedStatement` object, which must be an SQL Data Manipulation Language (DML) statement, such as `INSERT`, `UPDATE` or `DELETE`; or an SQL statement that returns nothing, such as a DDL statement.
`abstract ResultSetMetaData`	`getMetaData()` Retrieves a `ResultSetMetaData` object that contains information about the columns of the `ResultSet` object that will be returned when this `PreparedStatement` object is executed.
`abstract ParameterMetaData`	`getParameterMetaData()` Retrieves the number, types and properties of this `PreparedStatement` object's parameters.
`abstract void`	`setArray(int parameterIndex, Array x)` Sets the designated parameter to the given `java.sql.Array` object.
`abstract void`	`setAsciiStream(int parameterIndex, InputStream x, long length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`abstract void`	`setAsciiStream(int parameterIndex, InputStream x)` Sets the designated parameter to the given input stream.
`abstract void`	`setAsciiStream(int parameterIndex, InputStream x, int length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`abstract void`	`setBigDecimal(int parameterIndex, BigDecimal x)` Sets the designated parameter to the given `java.math.BigDecimal` value.
`abstract void`	`setBinaryStream(int parameterIndex, InputStream x, long length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`abstract void`	`setBinaryStream(int parameterIndex, InputStream x)` Sets the designated parameter to the given input stream.
`abstract void`	`setBinaryStream(int parameterIndex, InputStream x, int length)` Sets the designated parameter to the given input stream, which will have the specified number of bytes.
`abstract void`	`setBlob(int parameterIndex, InputStream inputStream, long length)` Sets the designated parameter to a `InputStream` object.
`abstract void`	`setBlob(int parameterIndex, InputStream inputStream)` Sets the designated parameter to a `InputStream` object.
`abstract void`	`setBlob(int parameterIndex, Blob x)` Sets the designated parameter to the given `java.sql.Blob` object.
`abstract void`	`setBoolean(int parameterIndex, boolean x)` Sets the designated parameter to the given Java `boolean` value.
`abstract void`	`setByte(int parameterIndex, byte x)` Sets the designated parameter to the given Java `byte` value.
`abstract void`	`setBytes(int parameterIndex, byte[] x)` Sets the designated parameter to the given Java array of bytes.
`abstract void`	`setCharacterStream(int parameterIndex, Reader reader, long length)` Sets the designated parameter to the given `Reader` object, which is the given number of characters long.
`abstract void`	`setCharacterStream(int parameterIndex, Reader reader, int length)` Sets the designated parameter to the given `Reader` object, which is the given number of characters long.
`abstract void`	`setCharacterStream(int parameterIndex, Reader reader)` Sets the designated parameter to the given `Reader` object.
`abstract void`	`setClob(int parameterIndex, Clob x)` Sets the designated parameter to the given `java.sql.Clob` object.
`abstract void`	`setClob(int parameterIndex, Reader reader, long length)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setClob(int parameterIndex, Reader reader)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setDate(int parameterIndex, Date x)` Sets the designated parameter to the given `java.sql.Date` value using the default time zone of the virtual machine that is running the application.
`abstract void`	`setDate(int parameterIndex, Date x, Calendar cal)` Sets the designated parameter to the given `java.sql.Date` value, using the given `Calendar` object.
`abstract void`	`setDouble(int parameterIndex, double x)` Sets the designated parameter to the given Java `double` value.
`abstract void`	`setFloat(int parameterIndex, float x)` Sets the designated parameter to the given Java `float` value.
`abstract void`	`setInt(int parameterIndex, int x)` Sets the designated parameter to the given Java `int` value.
`abstract void`	`setLong(int parameterIndex, long x)` Sets the designated parameter to the given Java `long` value.
`abstract void`	`setNCharacterStream(int parameterIndex, Reader value, long length)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setNCharacterStream(int parameterIndex, Reader value)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setNClob(int parameterIndex, Reader reader, long length)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setNClob(int parameterIndex, NClob value)` Sets the designated parameter to a `java.sql.NClob` object.
`abstract void`	`setNClob(int parameterIndex, Reader reader)` Sets the designated parameter to a `Reader` object.
`abstract void`	`setNString(int parameterIndex, String value)` Sets the designated paramter to the given `String` object.
`abstract void`	`setNull(int parameterIndex, int sqlType, String typeName)` Sets the designated parameter to SQL `NULL`.
`abstract void`	`setNull(int parameterIndex, int sqlType)` Sets the designated parameter to SQL `NULL`.
`abstract void`	`setObject(int parameterIndex, Object x, int targetSqlType)` Sets the value of the designated parameter with the given object.
`abstract void`	`setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength)` Sets the value of the designated parameter with the given object.
`abstract void`	`setObject(int parameterIndex, Object x)` Sets the value of the designated parameter using the given object.
`abstract void`	`setRef(int parameterIndex, Ref x)` Sets the designated parameter to the given `REF(<structured-type>)` value.
`abstract void`	`setRowId(int parameterIndex, RowId x)` Sets the designated parameter to the given `java.sql.RowId` object.
`abstract void`	`setSQLXML(int parameterIndex, SQLXML xmlObject)` Sets the designated parameter to the given `java.sql.SQLXML` object.
`abstract void`	`setShort(int parameterIndex, short x)` Sets the designated parameter to the given Java `short` value.
`abstract void`	`setString(int parameterIndex, String x)` Sets the designated parameter to the given Java `String` value.
`abstract void`	`setTime(int parameterIndex, Time x, Calendar cal)` Sets the designated parameter to the given `java.sql.Time` value, using the given `Calendar` object.
`abstract void`	`setTime(int parameterIndex, Time x)` Sets the designated parameter to the given `java.sql.Time` value.
`abstract void`	`setTimestamp(int parameterIndex, Timestamp x)` Sets the designated parameter to the given `java.sql.Timestamp` value.
`abstract void`	`setTimestamp(int parameterIndex, Timestamp x, Calendar cal)` Sets the designated parameter to the given `java.sql.Timestamp` value, using the given `Calendar` object.
`abstract void`	`setURL(int parameterIndex, URL x)` Sets the designated parameter to the given `java.net.URL` value.
`abstract void`	`setUnicodeStream(int parameterIndex, InputStream x, int length)` This method was deprecated in API level 15. Use setCharacterStream

From interface


        
          java.sql.Statement

`abstract void`	`addBatch(String sql)` Adds the given SQL command to the current list of commmands for this `Statement` object.
`abstract void`	`cancel()` Cancels this `Statement` object if both the DBMS and driver support aborting an SQL statement.
`abstract void`	`clearBatch()` Empties this `Statement` object's current list of SQL commands.
`abstract void`	`clearWarnings()` Clears all the warnings reported on this `Statement` object.
`abstract void`	`close()` Releases this `Statement` object's database and JDBC resources immediately instead of waiting for this to happen when it is automatically closed.
`abstract boolean`	`execute(String sql, int autoGeneratedKeys)` Executes the given SQL statement, which may return multiple results, and signals the driver that any auto-generated keys should be made available for retrieval.
`abstract boolean`	`execute(String sql)` Executes the given SQL statement, which may return multiple results.
`abstract boolean`	`execute(String sql, int[] columnIndexes)` Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
`abstract boolean`	`execute(String sql, String[] columnNames)` Executes the given SQL statement, which may return multiple results, and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
`abstract int[]`	`executeBatch()` Submits a batch of commands to the database for execution and if all commands execute successfully, returns an array of update counts.
`abstract ResultSet`	`executeQuery(String sql)` Executes the given SQL statement, which returns a single `ResultSet` object.
`abstract int`	`executeUpdate(String sql)` Executes the given SQL statement, which may be an `INSERT`, `UPDATE`, or `DELETE` statement or an SQL statement that returns nothing, such as an SQL DDL statement.
`abstract int`	`executeUpdate(String sql, String[] columnNames)` Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
`abstract int`	`executeUpdate(String sql, int[] columnIndexes)` Executes the given SQL statement and signals the driver that the auto-generated keys indicated in the given array should be made available for retrieval.
`abstract int`	`executeUpdate(String sql, int autoGeneratedKeys)` Executes the given SQL statement and signals the driver with the given flag about whether the auto-generated keys produced by this `Statement` object should be made available for retrieval.
`abstract Connection`	`getConnection()` Retrieves the `Connection` object that produced this `Statement` object.
`abstract int`	`getFetchDirection()` Retrieves the direction for fetching rows from database tables that is the default for result sets generated from this `Statement` object.
`abstract int`	`getFetchSize()` Retrieves the number of result set rows that is the default fetch size for `ResultSet` objects generated from this `Statement` object.
`abstract ResultSet`	`getGeneratedKeys()` Retrieves any auto-generated keys created as a result of executing this `Statement` object.
`abstract int`	`getMaxFieldSize()` Retrieves the maximum number of bytes that can be returned for character and binary column values in a `ResultSet` object produced by this `Statement` object.
`abstract int`	`getMaxRows()` Retrieves the maximum number of rows that a `ResultSet` object produced by this `Statement` object can contain.
`abstract boolean`	`getMoreResults(int current)` Moves to this `Statement` object's next result, deals with any current `ResultSet` object(s) according to the instructions specified by the given flag, and returns `true` if the next result is a `ResultSet` object.
`abstract boolean`	`getMoreResults()` Moves to this `Statement` object's next result, returns `true` if it is a `ResultSet` object, and implicitly closes any current `ResultSet` object(s) obtained with the method `getResultSet`.
`abstract int`	`getQueryTimeout()` Retrieves the number of seconds the driver will wait for a `Statement` object to execute.
`abstract ResultSet`	`getResultSet()` Retrieves the current result as a `ResultSet` object.
`abstract int`	`getResultSetConcurrency()` Retrieves the result set concurrency for `ResultSet` objects generated by this `Statement` object.
`abstract int`	`getResultSetHoldability()` Retrieves the result set holdability for `ResultSet` objects generated by this `Statement` object.
`abstract int`	`getResultSetType()` Retrieves the result set type for `ResultSet` objects generated by this `Statement` object.
`abstract int`	`getUpdateCount()` Retrieves the current result as an update count; if the result is a `ResultSet` object or there are no more results, -1 is returned.
`abstract SQLWarning`	`getWarnings()` Retrieves the first warning reported by calls on this `Statement` object.
`abstract boolean`	`isClosed()` Retrieves whether this `Statement` object has been closed.
`abstract boolean`	`isPoolable()` Returns a value indicating whether the `Statement` is poolable or not.
`abstract void`	`setCursorName(String name)` Sets the SQL cursor name to the given `String`, which will be used by subsequent `Statement` object `execute` methods.
`abstract void`	`setEscapeProcessing(boolean enable)` Sets escape processing on or off.
`abstract void`	`setFetchDirection(int direction)` Gives the driver a hint as to the direction in which rows will be processed in `ResultSet` objects created using this `Statement` object.
`abstract void`	`setFetchSize(int rows)` Gives the JDBC driver a hint as to the number of rows that should be fetched from the database when more rows are needed for `ResultSet` objects genrated by this `Statement`.
`abstract void`	`setMaxFieldSize(int max)` Sets the limit for the maximum number of bytes that can be returned for character and binary column values in a `ResultSet` object produced by this `Statement` object.
`abstract void`	`setMaxRows(int max)` Sets the limit for the maximum number of rows that any `ResultSet` object generated by this `Statement` object can contain to the given number.
`abstract void`	`setPoolable(boolean poolable)` Requests that a `Statement` be pooled or not pooled.
`abstract void`	`setQueryTimeout(int seconds)` Sets the number of seconds the driver will wait for a `Statement` object to execute to the given number of seconds.

From interface


        
          java.sql.Wrapper

`abstract boolean`	`isWrapperFor(Class<?> iface)` Returns true if this either implements the interface argument or is directly or indirectly a wrapper for an object that does.
`abstract <T> T`	`unwrap(Class<T> iface)` Returns an object that implements the given interface to allow access to non-standard methods, or standard methods not exposed by the proxy.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Public methods

getArray

Added in API level 1

public abstract Array getArray (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

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

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getArray

Added in API level 1

public abstract Array getArray (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`Array`	the parameter value as an `Array` object in Java programming language. If the value was SQL `NULL`, the value `null` 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getBigDecimal

Added in API level 1

public abstract BigDecimal getBigDecimal (String parameterName)

Retrieves the value of a JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.

Parameters
`parameterName`	`String`: the name of the parameter

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

Throws
	parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method
`SQLException`

See also:

PreparedStatement.setBigDecimal(int, BigDecimal)

getBigDecimal

Added in API level 1
Deprecated in API level 15

public abstract BigDecimal getBigDecimal (int parameterIndex, 
                int scale)

This method was deprecated in API level 15.
use getBigDecimal(int parameterIndex) or getBigDecimal(String parameterName)

Retrieves the value of the designated JDBC NUMERIC parameter as a java.math.BigDecimal object with scale digits to the right of the decimal point.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on
`scale`	`int`: the number of digits to the right of the decimal point

Returns
`BigDecimal`	the parameter value. If the value is SQL `NULL`, the result is `null`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setBigDecimal(int, BigDecimal)

getBigDecimal

Added in API level 1

public abstract BigDecimal getBigDecimal (int parameterIndex)

Retrieves the value of the designated JDBC NUMERIC parameter as a java.math.BigDecimal object with as many digits to the right of the decimal point as the value contains.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

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

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setBigDecimal(int, BigDecimal)

getBlob

Added in API level 1

public abstract Blob getBlob (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

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

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getBlob

Added in API level 1

public abstract Blob getBlob (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

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

Throws
`SQLException`	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getBoolean

Added in API level 1

public abstract boolean getBoolean (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`boolean`	the parameter value. If the value is SQL `NULL`, the result is `false`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setBoolean(int, boolean)

getBoolean

Added in API level 1

public abstract boolean getBoolean (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`boolean`	the parameter value. If the value is SQL `NULL`, the result is `false`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setBoolean(int, boolean)

getByte

Added in API level 1

public abstract byte getByte (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`byte`	the parameter value. If the value is SQL `NULL`, the result is `0`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setByte(int, byte)

getByte

Added in API level 1

public abstract byte getByte (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`byte`	the parameter value. If the value is SQL `NULL`, the result is `0`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setByte(int, byte)

getBytes

Added in API level 1

public abstract byte[] getBytes (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`byte[]`	the parameter value. If the value is SQL `NULL`, the result is `null`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setBytes(int, byte)

getBytes

Added in API level 1

public abstract byte[] getBytes (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`byte[]`	the parameter value. If the value is SQL `NULL`, the result is `null`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setBytes(int, byte)

getCharacterStream

Added in API level 9

public abstract Reader getCharacterStream (int parameterIndex)

Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, ...

Returns
`Reader`	a `java.io.Reader` object that contains the parameter value; if the value is SQL `NULL`, the value returned is `null` in the Java programming language.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

getCharacterStream

Added in API level 9

public abstract Reader getCharacterStream (String parameterName)

Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language.

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`Reader`	a `java.io.Reader` object that contains the parameter value; if the value is SQL `NULL`, the value returned is `null` in the Java programming language

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getClob

Added in API level 1

public abstract Clob getClob (int parameterIndex)

Retrieves the value of the designated JDBC CLOB parameter as a java.sql.Clob object in the Java programming language.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

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

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getClob

Added in API level 1

public abstract Clob getClob (String parameterName)

Retrieves the value of a JDBC CLOB parameter as a java.sql.Clob object in the Java programming language.

Parameters
`parameterName`	`String`: the name of the parameter

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

Throws
`SQLException`	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getDate

Added in API level 1

public abstract Date getDate (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`Date`	the parameter value. If the value is SQL `NULL`, the result is `null`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setDate(int, Date)

getDate

Added in API level 1

public abstract Date getDate (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`Date`	the parameter value. If the value is SQL `NULL`, the result is `null`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setDate(int, Date)

getDate

Added in API level 1

public abstract Date getDate (String parameterName, 
                Calendar cal)

Retrieves the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date. With a Calendar object, the driver can calculate the date taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Parameters
`parameterName`	`String`: the name of the parameter
`cal`	`Calendar`: the `Calendar` object the driver will use to construct the date

Returns
`Date`	the parameter value. If the value is SQL `NULL`, the result is `null`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setDate(int, Date)

getDate

Added in API level 1

public abstract Date getDate (int parameterIndex, 
                Calendar cal)

Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date. With a Calendar object, the driver can calculate the date taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on
`cal`	`Calendar`: the `Calendar` object the driver will use to construct the date

Returns
`Date`	the parameter value. If the value is SQL `NULL`, the result is `null`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setDate(int, Date)

getDouble

Added in API level 1

public abstract double getDouble (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`double`	the parameter value. If the value is SQL `NULL`, the result is `0`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setDouble(int, double)

getDouble

Added in API level 1

public abstract double getDouble (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`double`	the parameter value. If the value is SQL `NULL`, the result is `0`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setDouble(int, double)

getFloat

Added in API level 1

public abstract float getFloat (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`float`	the parameter value. If the value is SQL `NULL`, the result is `0`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setFloat(int, float)

getFloat

Added in API level 1

public abstract float getFloat (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`float`	the parameter value. If the value is SQL `NULL`, the result is `0`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setFloat(int, float)

getInt

Added in API level 1

public abstract int getInt (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`int`	the parameter value. If the value is SQL `NULL`, the result is `0`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setInt(int, int)

getInt

Added in API level 1

public abstract int getInt (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`int`	the parameter value. If the value is SQL `NULL`, the result is `0`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setInt(int, int)

getLong

Added in API level 1

public abstract long getLong (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`long`	the parameter value. If the value is SQL `NULL`, the result is `0`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setLong(int, long)

getLong

Added in API level 1

public abstract long getLong (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`long`	the parameter value. If the value is SQL `NULL`, the result is `0`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setLong(int, long)

getNCharacterStream

Added in API level 9

public abstract Reader getNCharacterStream (int parameterIndex)

Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language. It is intended for use when accessing NCHAR,NVARCHAR and LONGNVARCHAR parameters.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, ...

Returns
`Reader`	a `java.io.Reader` object that contains the parameter value; if the value is SQL `NULL`, the value returned is `null` in the Java programming language.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getNCharacterStream

Added in API level 9

public abstract Reader getNCharacterStream (String parameterName)

Retrieves the value of the designated parameter as a java.io.Reader object in the Java programming language. It is intended for use when accessing NCHAR,NVARCHAR and LONGNVARCHAR parameters.

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`Reader`	a `java.io.Reader` object that contains the parameter value; if the value is SQL `NULL`, the value returned is `null` in the Java programming language

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getNClob

Added in API level 9

public abstract NClob getNClob (String parameterName)

Retrieves the value of a JDBC NCLOB parameter as a java.sql.NClob object in the Java programming language.

Parameters
`parameterName`	`String`: the name of the parameter

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

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getNClob

Added in API level 9

public abstract NClob getNClob (int parameterIndex)

Retrieves the value of the designated JDBC NCLOB parameter as a java.sql.NClob object in the Java programming language.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

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

Throws
`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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getNString

Added in API level 9

public abstract String getNString (String parameterName)

Retrieves the value of the designated NCHAR, NVARCHAR or LONGNVARCHAR parameter as a String in the Java programming language.

For the fixed-length type JDBC NCHAR, the String object returned has exactly the same value the SQL NCHAR value had in the database, including any padding added by the database.

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`String`	a `String` object that maps an `NCHAR`, `NVARCHAR` or `LONGNVARCHAR` 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setNString(int, String)

getNString

Added in API level 9

public abstract String getNString (int parameterIndex)

Retrieves the value of the designated NCHAR, NVARCHAR or LONGNVARCHAR parameter as a String in the Java programming language.

For the fixed-length type JDBC NCHAR, the String object returned has exactly the same value the SQL NCHAR value had in the database, including any padding added by the database.

Parameters
`parameterIndex`	`int`: index of the first parameter is 1, the second is 2, ...

Returns
`String`	a `String` object that maps an `NCHAR`, `NVARCHAR` or `LONGNVARCHAR` value

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setNString(int, String)

getObject

Added in API level 1

public abstract Object getObject (String parameterName, 
                Map<String, Class<?>> map)

Returns an object representing the value of OUT parameter parameterName 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.

Parameters
`parameterName`	`String`: the name of the parameter
`map`	`Map`: the mapping from SQL type names to Java classes

Returns
`Object`	a `java.lang.Object` holding the OUT 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setObject(int, Object)

getObject

Added in API level 1

public abstract Object getObject (int parameterIndex, 
                Map<String, Class<?>> map)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on
`map`	`Map`: the mapping from SQL type names to Java classes

Returns
`Object`	a `java.lang.Object` holding the OUT parameter value

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setObject(int, Object)

getObject

Added in API level 1

public abstract Object getObject (int parameterIndex)

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.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

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

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

getObject

Added in API level 1

public abstract Object getObject (String parameterName)

Retrieves the value of a parameter as an Object in the Java programming language. If the value is an SQL NULL, the driver returns a Java null.

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`Object`	A `java.lang.Object` holding the OUT 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getRef

Added in API level 1

public abstract Ref getRef (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

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

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getRef

Added in API level 1

public abstract Ref getRef (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

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

Throws
`SQLException`	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getRowId

Added in API level 9

public abstract RowId getRowId (int parameterIndex)

Retrieves the value of the designated JDBC ROWID parameter as a java.sql.RowId object.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2,...

Returns
`RowId`	a `RowId` object that represents the JDBC `ROWID` value is used as the designated parameter. If the parameter contains a SQL `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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getRowId

Added in API level 9

public abstract RowId getRowId (String parameterName)

Retrieves the value of the designated JDBC ROWID parameter as a java.sql.RowId object.

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`RowId`	a `RowId` object that represents the JDBC `ROWID` value is used as the designated parameter. If the parameter contains a SQL `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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getSQLXML

Added in API level 9

public abstract SQLXML getSQLXML (String parameterName)

Retrieves the value of the designated SQL XML parameter as a java.sql.SQLXML object in the Java programming language.

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`SQLXML`	a `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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getSQLXML

Added in API level 9

public abstract SQLXML getSQLXML (int parameterIndex)

Retrieves the value of the designated SQL XML parameter as a java.sql.SQLXML object in the Java programming language.

Parameters
`parameterIndex`	`int`: index of the first parameter is 1, the second is 2, ...

Returns
`SQLXML`	a `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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

getShort

Added in API level 1

public abstract short getShort (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`short`	the parameter value. If the value is SQL `NULL`, the result is `0`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setShort(int, short)

getShort

Added in API level 1

public abstract short getShort (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`short`	the parameter value. If the value is SQL `NULL`, the result is `0`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setShort(int, short)

getString

Added in API level 1

public abstract String getString (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`String`	the parameter value. If the value is SQL `NULL`, the result is `null`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setString(int, String)

getString

Added in API level 1

public abstract String getString (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`String`	the parameter value. If the value is SQL `NULL`, the result is `null`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setString(int, String)

getTime

Added in API level 1

public abstract Time getTime (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`Time`	the parameter value. If the value is SQL `NULL`, the result is `null`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setTime(int, Time)

getTime

Added in API level 1

public abstract Time getTime (String parameterName, 
                Calendar cal)

Retrieves the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time. With a Calendar object, the driver can calculate the time taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Parameters
`parameterName`	`String`: the name of the parameter
`cal`	`Calendar`: the `Calendar` object the driver will use to construct the time

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

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setTime(int, Time)

getTime

Added in API level 1

public abstract Time getTime (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`Time`	the parameter value. If the value is SQL `NULL`, the result is `null`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setTime(int, Time)

getTime

Added in API level 1

public abstract Time getTime (int parameterIndex, 
                Calendar cal)

Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time. With a Calendar object, the driver can calculate the time taking into account a custom timezone and locale. If no Calendar object is specified, the driver uses the default timezone and locale.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on
`cal`	`Calendar`: the `Calendar` object the driver will use to construct the time

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

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setTime(int, Time)

getTimestamp

Added in API level 1

public abstract Timestamp getTimestamp (int parameterIndex, 
                Calendar cal)

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.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on
`cal`	`Calendar`: the `Calendar` object the driver will use to construct the timestamp

Returns
`Timestamp`	the parameter value. If the value is SQL `NULL`, the result is `null`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setTimestamp(int, Timestamp)

getTimestamp

Added in API level 1

public abstract Timestamp getTimestamp (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on

Returns
`Timestamp`	the parameter value. If the value is SQL `NULL`, the result is `null`.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`

See also:

PreparedStatement.setTimestamp(int, Timestamp)

getTimestamp

Added in API level 1

public abstract Timestamp getTimestamp (String parameterName, 
                Calendar cal)

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.

Parameters
`parameterName`	`String`: the name of the parameter
`cal`	`Calendar`: the `Calendar` object the driver will use to construct the timestamp

Returns
`Timestamp`	the parameter value. If the value is SQL `NULL`, the result is `null`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setTimestamp(int, Timestamp)

getTimestamp

Added in API level 1

public abstract Timestamp getTimestamp (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`Timestamp`	the parameter value. If the value is SQL `NULL`, the result is `null`.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setTimestamp(int, Timestamp)

getURL

Added in API level 1

public abstract URL getURL (int parameterIndex)

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

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2,...

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

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs, this method is called on a closed `CallableStatement`, or if the URL being returned is not a valid URL on the Java platform
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setURL(int, URL)

getURL

Added in API level 1

public abstract URL getURL (String parameterName)

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

Parameters
`parameterName`	`String`: the name of the parameter

Returns
`URL`	the parameter value as a `java.net.URL` object in the Java programming language. If the value was SQL `NULL`, the value `null` is returned.

Throws
`SQLException`	if parameterName does not correspond to a named parameter; if a database access error occurs, this method is called on a closed `CallableStatement`, or if there is a problem with the URL
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

PreparedStatement.setURL(int, URL)

registerOutParameter

Added in API level 1

public abstract void registerOutParameter (int parameterIndex, 
                int sqlType)

Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

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

If the JDBC type expected to be returned to this output parameter is specific to this particular database, sqlType should be java.sql.Types.OTHER. The method getObject(int) retrieves the value.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on
`sqlType`	`int`: 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.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if `sqlType` is a `ARRAY`, `BLOB`, `CLOB`, `DATALINK`, `JAVA_OBJECT`, `NCHAR`, `NCLOB`, `NVARCHAR`, `LONGNVARCHAR`, `REF`, `ROWID`, `SQLXML` or `STRUCT` data type and the JDBC driver does not support this data type

See also:

Types

registerOutParameter

Added in API level 1

public abstract void registerOutParameter (String parameterName, 
                int sqlType, 
                String typeName)

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.

All OUT parameters must be registered before a stored procedure is executed.

For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.

Note: When reading the value of an out parameter, you must use the getXXX method whose Java type XXX corresponds to the parameter's registered SQL type.

Parameters
`parameterName`	`String`: the name of the parameter
`sqlType`	`int`: a value from `Types`
`typeName`	`String`: the fully-qualified name of an SQL structured type

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if `sqlType` is a `ARRAY`, `BLOB`, `CLOB`, `DATALINK`, `JAVA_OBJECT`, `NCHAR`, `NCLOB`, `NVARCHAR`, `LONGNVARCHAR`, `REF`, `ROWID`, `SQLXML` or `STRUCT` data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method

See also:

Types

registerOutParameter

Added in API level 1

public abstract void registerOutParameter (int parameterIndex, 
                int sqlType, 
                String typeName)

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.

All OUT parameters must be registered before a stored procedure is executed.

For a user-defined parameter, the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-defined and REF parameters. Although it is intended for user-defined and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the typeName parameter is ignored.

Note: When reading the value of an out parameter, you must use the getter method whose Java type corresponds to the parameter's registered SQL type.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2,...
`sqlType`	`int`: a value from `Types`
`typeName`	`String`: the fully-qualified name of an SQL structured type

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if `sqlType` is a `ARRAY`, `BLOB`, `CLOB`, `DATALINK`, `JAVA_OBJECT`, `NCHAR`, `NCLOB`, `NVARCHAR`, `LONGNVARCHAR`, `REF`, `ROWID`, `SQLXML` or `STRUCT` data type and the JDBC driver does not support this data type

See also:

Types

registerOutParameter

Added in API level 1

public abstract void registerOutParameter (int parameterIndex, 
                int sqlType, 
                int scale)

Registers the parameter in ordinal position parameterIndex to be of 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.

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

Parameters
`parameterIndex`	`int`: the first parameter is 1, the second is 2, and so on
`sqlType`	`int`: the SQL type code defined by `java.sql.Types`.
`scale`	`int`: the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

Throws
`SQLException`	if the parameterIndex is not valid; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if `sqlType` is a `ARRAY`, `BLOB`, `CLOB`, `DATALINK`, `JAVA_OBJECT`, `NCHAR`, `NCLOB`, `NVARCHAR`, `LONGNVARCHAR`, `REF`, `ROWID`, `SQLXML` or `STRUCT` data type and the JDBC driver does not support this data type

See also:

Types

registerOutParameter

Added in API level 1

public abstract void registerOutParameter (String parameterName, 
                int sqlType, 
                int scale)

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

This version of registerOutParameter should be used when the parameter is of JDBC type NUMERIC or DECIMAL.

Parameters
`parameterName`	`String`: the name of the parameter
`sqlType`	`int`: SQL type code defined by `java.sql.Types`.
`scale`	`int`: the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if `sqlType` is a `ARRAY`, `BLOB`, `CLOB`, `DATALINK`, `JAVA_OBJECT`, `NCHAR`, `NCLOB`, `NVARCHAR`, `LONGNVARCHAR`, `REF`, `ROWID`, `SQLXML` or `STRUCT` data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method

See also:

Types

registerOutParameter

Added in API level 1

public abstract void registerOutParameter (String parameterName, 
                int sqlType)

Registers the OUT parameter named parameterName to the JDBC type sqlType. All OUT parameters must be registered before a stored procedure is executed.

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

If the JDBC type expected to be returned to this output parameter is specific to this particular database, sqlType should be java.sql.Types.OTHER. The method getObject(int) retrieves the value.

Parameters
`parameterName`	`String`: the name of the parameter
`sqlType`	`int`: 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.

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if `sqlType` is a `ARRAY`, `BLOB`, `CLOB`, `DATALINK`, `JAVA_OBJECT`, `NCHAR`, `NCLOB`, `NVARCHAR`, `LONGNVARCHAR`, `REF`, `ROWID`, `SQLXML` or `STRUCT` data type and the JDBC driver does not support this data type or if the JDBC driver does not support this method

See also:

Types

setAsciiStream

Added in API level 1

public abstract void setAsciiStream (String parameterName, 
                InputStream x, 
                int length)

Sets the designated parameter to the given input stream, which will have the specified number of bytes. 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.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`InputStream`: the Java input stream that contains the ASCII parameter value
`length`	`int`: the number of bytes in the stream

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setAsciiStream

Added in API level 9

public abstract void setAsciiStream (String parameterName, 
                InputStream x, 
                long length)

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`InputStream`: the Java input stream that contains the ASCII parameter value
`length`	`long`: the number of bytes in the stream

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setAsciiStream

Added in API level 9

public abstract void setAsciiStream (String parameterName, 
                InputStream x)

Sets the designated parameter to the given input stream. 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.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setAsciiStream which takes a length parameter.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`InputStream`: the Java input stream that contains the ASCII 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setBigDecimal

Added in API level 1

public abstract void setBigDecimal (String parameterName, 
                BigDecimal x)

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.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`BigDecimal`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getBigDecimal(int)

setBinaryStream

Added in API level 9

public abstract void setBinaryStream (String parameterName, 
                InputStream x)

Sets the designated parameter to the given input stream. 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.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBinaryStream which takes a length parameter.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`InputStream`: the java input stream which contains the binary 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setBinaryStream

Added in API level 9

public abstract void setBinaryStream (String parameterName, 
                InputStream x, 
                long length)

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.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`InputStream`: the java input stream which contains the binary parameter value
`length`	`long`: the number of bytes in the stream

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setBinaryStream

Added in API level 1

public abstract void setBinaryStream (String parameterName, 
                InputStream x, 
                int length)

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`InputStream`: the java input stream which contains the binary parameter value
`length`	`int`: the number of bytes in the stream

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setBlob

Added in API level 9

public abstract void setBlob (String parameterName, 
                Blob x)

Sets the designated parameter to the given java.sql.Blob object. The driver converts this to an SQL BLOB value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Blob`: a `Blob` object that maps an SQL `BLOB` 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setBlob

Added in API level 9

public abstract void setBlob (String parameterName, 
                InputStream inputStream, 
                long length)

Sets the designated parameter to a InputStream object. The inputstream must contain the number of characters specified by length, otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setBinaryStream (int, InputStream, int) method because it informs the driver that the parameter value should be sent to the server as a 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 LONGVARBINARY or a BLOB

Parameters
`parameterName`	`String`: the name of the parameter to be set the second is 2, ...
`inputStream`	`InputStream`: An object that contains the data to set the parameter value to.
`length`	`long`: 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 specfied length; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setBlob

Added in API level 9

public abstract void setBlob (String parameterName, 
                InputStream inputStream)

Sets the designated parameter to a InputStream object. This method differs from the setBinaryStream (int, InputStream) method because it informs the driver that the parameter value should be sent to the server as a 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 LONGVARBINARY or a BLOB

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setBlob which takes a length parameter.

Parameters
`parameterName`	`String`: the name of the parameter
`inputStream`	`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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setBoolean

Added in API level 1

public abstract void setBoolean (String parameterName, 
                boolean x)

Sets the designated parameter to the given Java boolean value. The driver converts this to an SQL BIT or BOOLEAN value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`boolean`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getBoolean(int)

setByte

Added in API level 1

public abstract void setByte (String parameterName, 
                byte x)

Sets the designated parameter to the given Java byte value. The driver converts this to an SQL TINYINT value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`byte`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getByte(int)

setBytes

Added in API level 1

public abstract void setBytes (String parameterName, 
                byte[] x)

Sets the designated parameter to the given Java array of bytes. The driver converts this to an SQL VARBINARY or LONGVARBINARY (depending on the argument's size relative to the driver's limits on VARBINARY values) when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`byte`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getBytes(int)

setCharacterStream

Added in API level 1

public abstract void setCharacterStream (String parameterName, 
                Reader reader, 
                int length)

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.

Parameters
`parameterName`	`String`: the name of the parameter
`reader`	`Reader`: the `java.io.Reader` object that contains the UNICODE data used as the designated parameter
`length`	`int`: the number of characters in the stream

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setCharacterStream

Added in API level 9

public abstract void setCharacterStream (String parameterName, 
                Reader reader, 
                long length)

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Parameters
`parameterName`	`String`: the name of the parameter
`reader`	`Reader`: the `java.io.Reader` object that contains the UNICODE data used as the designated parameter
`length`	`long`: the number of characters in the stream

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setCharacterStream

Added in API level 9

public abstract void setCharacterStream (String parameterName, 
                Reader reader)

Sets the designated parameter to the given Reader object. 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.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setCharacterStream which takes a length parameter.

Parameters
`parameterName`	`String`: the name of the parameter
`reader`	`Reader`: the `java.io.Reader` object that contains the Unicode data

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setClob

Added in API level 9

public abstract void setClob (String parameterName, 
                Clob x)

Sets the designated parameter to the given java.sql.Clob object. The driver converts this to an SQL CLOB value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Clob`: a `Clob` object that maps an SQL `CLOB` 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setClob

Added in API level 9

public abstract void setClob (String parameterName, 
                Reader reader, 
                long length)

Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a 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 LONGVARCHAR or a CLOB

Parameters
`parameterName`	`String`: the name of the parameter to be set
`reader`	`Reader`: An object that contains the data to set the parameter value to.
`length`	`long`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setClob

Added in API level 9

public abstract void setClob (String parameterName, 
                Reader reader)

Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a 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 LONGVARCHAR or a CLOB

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setClob which takes a length parameter.

Parameters
`parameterName`	`String`: the name of the parameter
`reader`	`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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setDate

Added in API level 1

public abstract void setDate (String parameterName, 
                Date x, 
                Calendar cal)

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.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Date`: the parameter value
`cal`	`Calendar`: the `Calendar` object the driver will use to construct the date

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getDate(int)

setDate

Added in API level 1

public abstract void setDate (String parameterName, 
                Date x)

Sets the designated parameter to the given 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 DATE value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Date`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getDate(int)

setDouble

Added in API level 1

public abstract void setDouble (String parameterName, 
                double x)

Sets the designated parameter to the given Java double value. The driver converts this to an SQL DOUBLE value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`double`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getDouble(int)

setFloat

Added in API level 1

public abstract void setFloat (String parameterName, 
                float x)

Sets the designated parameter to the given Java float value. The driver converts this to an SQL FLOAT value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`float`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getFloat(int)

setInt

Added in API level 1

public abstract void setInt (String parameterName, 
                int x)

Sets the designated parameter to the given Java int value. The driver converts this to an SQL INTEGER value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`int`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getInt(int)

setLong

Added in API level 1

public abstract void setLong (String parameterName, 
                long x)

Sets the designated parameter to the given Java long value. The driver converts this to an SQL BIGINT value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`long`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getLong(int)

setNCharacterStream

Added in API level 9

public abstract void setNCharacterStream (String parameterName, 
                Reader value, 
                long length)

Sets the designated parameter to a Reader object. The 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.

Parameters
`parameterName`	`String`: the name of the parameter to be set
`value`	`Reader`: the parameter value
`length`	`long`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setNCharacterStream

Added in API level 9

public abstract void setNCharacterStream (String parameterName, 
                Reader value)

Note: This stream object can either be a standard Java stream object or your own subclass that implements the standard interface.

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNCharacterStream which takes a length parameter.

Parameters
`parameterName`	`String`: the name of the parameter
`value`	`Reader`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setNClob

Added in API level 9

public abstract void setNClob (String parameterName, 
                Reader reader, 
                long length)

Sets the designated parameter to a Reader object. The reader must contain the number of characters specified by length otherwise a SQLException will be generated when the CallableStatement is executed. This method differs from the setCharacterStream (int, Reader, int) method because it informs the driver that the parameter value should be sent to the server as a 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 LONGNVARCHAR or a NCLOB

Parameters
`parameterName`	`String`: the name of the parameter to be set
`reader`	`Reader`: An object that contains the data to set the parameter value to.
`length`	`long`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setNClob

Added in API level 9

public abstract void setNClob (String parameterName, 
                NClob value)

Sets the designated parameter to a java.sql.NClob object. The object implements the java.sql.NClob interface. This NClob object maps to a SQL NCLOB.

Parameters
`parameterName`	`String`: the name of the parameter to be set
`value`	`NClob`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setNClob

Added in API level 9

public abstract void setNClob (String parameterName, 
                Reader reader)

Sets the designated parameter to a Reader object. This method differs from the setCharacterStream (int, Reader) method because it informs the driver that the parameter value should be sent to the server as a 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 LONGNVARCHAR or a NCLOB

Note: Consult your JDBC driver documentation to determine if it might be more efficient to use a version of setNClob which takes a length parameter.

Parameters
`parameterName`	`String`: the name of the parameter
`reader`	`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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setNString

Added in API level 9

public abstract void setNString (String parameterName, 
                String value)

Sets the designated parameter to the given String object. The driver converts this to a SQL NCHAR or NVARCHAR or LONGNVARCHAR

Parameters
`parameterName`	`String`: the name of the parameter to be set
`value`	`String`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setNull

Added in API level 1

public abstract void setNull (String parameterName, 
                int sqlType)

Sets the designated parameter to SQL NULL.

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

Parameters
`parameterName`	`String`: the name of the parameter
`sqlType`	`int`: the SQL type code defined in `java.sql.Types`

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setNull

Added in API level 1

public abstract void setNull (String parameterName, 
                int sqlType, 
                String typeName)

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.

Although it is intended for user-defined and Ref parameters, this method may be used to set a null parameter of any JDBC type. If the parameter does not have a user-defined or REF type, the given typeName is ignored.

Parameters
`parameterName`	`String`: the name of the parameter
`sqlType`	`int`: a value from `java.sql.Types`
`typeName`	`String`: the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQL `REF` value

Throws
`SQLException`	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setObject

Added in API level 1

public abstract void setObject (String parameterName, 
                Object x, 
                int targetSqlType, 
                int scale)

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, NClob, Struct, java.net.URL, or Array, the driver should pass it to the database as a value of the corresponding SQL type.

Note that this method may be used to pass datatabase- specific abstract data types.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Object`: the object containing the input parameter value
`targetSqlType`	`int`: the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.
`scale`	`int`: for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.

Throws
`SQLException`	if parameterName does not correspond to a named parameter; if a database access error occurs or this method is called on a closed `CallableStatement`
`SQLFeatureNotSupportedException`	if `targetSqlType` is a `ARRAY`, `BLOB`, `CLOB`, `DATALINK`, `JAVA_OBJECT`, `NCHAR`, `NCLOB`, `NVARCHAR`, `LONGNVARCHAR`, `REF`, `ROWID`, `SQLXML` or `STRUCT` data type and the JDBC driver does not support this data type

See also:

Types
getObject(int)

setObject

Added in API level 1

public abstract void setObject (String parameterName, 
                Object x, 
                int targetSqlType)

Sets the value of the designated parameter with the given object. This method is like the method setObject above, except that it assumes a scale of zero.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Object`: the object containing the input parameter value
`targetSqlType`	`int`: the SQL type (as defined in java.sql.Types) to be sent to the database

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if `targetSqlType` is a `ARRAY`, `BLOB`, `CLOB`, `DATALINK`, `JAVA_OBJECT`, `NCHAR`, `NCLOB`, `NVARCHAR`, `LONGNVARCHAR`, `REF`, `ROWID`, `SQLXML` or `STRUCT` data type and the JDBC driver does not support this data type

See also:

getObject(int)

setObject

Added in API level 1

public abstract void setObject (String parameterName, 
                Object x)

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, NClob, Struct, java.net.URL, 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.

Note: Not all databases allow for a non-typed Null to be sent to the backend. For maximum portability, the setNull or the setObject(String parameterName, Object x, int sqlType) method should be used instead of setObject(String parameterName, Object x).

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Object`: the object containing the input parameter 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 `CallableStatement` or if the given `Object` parameter is ambiguous
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getObject(int)

setRowId

Added in API level 9

public abstract void setRowId (String parameterName, 
                RowId x)

Sets the designated parameter to the given java.sql.RowId object. The driver converts this to a SQL ROWID when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`RowId`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setSQLXML

Added in API level 9

public abstract void setSQLXML (String parameterName, 
                SQLXML xmlObject)

Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an SQL XML value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`xmlObject`	`SQLXML`: a `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 `CallableStatement` or the `java.xml.transform.Result`, `Writer` or `OutputStream` has not been closed for the `SQLXML` object
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

setShort

Added in API level 1

public abstract void setShort (String parameterName, 
                short x)

Sets the designated parameter to the given Java short value. The driver converts this to an SQL SMALLINT value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`short`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getShort(int)

setString

Added in API level 1

public abstract void setString (String parameterName, 
                String x)

Sets the designated parameter to the given Java String value. The driver converts this to an SQL VARCHAR or LONGVARCHAR value (depending on the argument's size relative to the driver's limits on VARCHAR values) when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`String`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getString(int)

setTime

Added in API level 1

public abstract void setTime (String parameterName, 
                Time x, 
                Calendar cal)

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.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Time`: the parameter value
`cal`	`Calendar`: the `Calendar` object the driver will use to construct the time

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getTime(int)

setTime

Added in API level 1

public abstract void setTime (String parameterName, 
                Time x)

Sets the designated parameter to the given java.sql.Time value. The driver converts this to an SQL TIME value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Time`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getTime(int)

setTimestamp

Added in API level 1

public abstract void setTimestamp (String parameterName, 
                Timestamp x, 
                Calendar cal)

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.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Timestamp`: the parameter value
`cal`	`Calendar`: the `Calendar` object the driver will use to construct the timestamp

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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getTimestamp(int)

setTimestamp

Added in API level 1

public abstract void setTimestamp (String parameterName, 
                Timestamp x)

Sets the designated parameter to the given java.sql.Timestamp value. The driver converts this to an SQL TIMESTAMP value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`x`	`Timestamp`: 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 `CallableStatement`
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getTimestamp(int)

setURL

Added in API level 1

public abstract void setURL (String parameterName, 
                URL val)

Sets the designated parameter to the given java.net.URL object. The driver converts this to an SQL DATALINK value when it sends it to the database.

Parameters
`parameterName`	`String`: the name of the parameter
`val`	`URL`: the parameter 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 `CallableStatement` or if a URL is malformed
`SQLFeatureNotSupportedException`	if the JDBC driver does not support this method

See also:

getURL(int)

wasNull

Added in API level 1

public abstract boolean wasNull ()

Retrieves whether the last OUT parameter read had the value of SQL NULL. Note that this method should be called only after calling a getter method; otherwise, there is no value to use in determining whether it is null or not.

Returns
`boolean`	`true` if the last parameter read was SQL `NULL`; `false` otherwise

Throws
`SQLException`	if a database access error occurs or this method is called on a closed `CallableStatement`