Summary: Inherited Constants | Methods | Inherited Methods | [Expand All]

Since: API Level 1

public interface

CallableStatement

implements PreparedStatement

java.sql.CallableStatement

Class Overview

An interface used to call Stored Procedures.

The JDBC API provides an SQL escape syntax allowing Stored Procedures to be called in a standard way for all databases. The JDBC escape syntax has two forms. One form includes a result parameter. The second form does not include a result parameter. Where the result parameter is used, it must be declared as an OUT parameter. Other parameters can be declared as IN, OUT, or INOUT. Parameters are referenced either by name or by a numerical index starting at 1.

The correct syntax is:

{ ?= call <procedurename> [( [parameter1,parameter2,...] )] }

{ call <procedurename> [( [parameter1,parameter2,...] )] }

IN parameters are set before calling the procedure, using the setter methods which are inherited from PreparedStatement. For OUT parameters, their type must be registered before executing the stored procedure. The values are retrieved using the getter methods defined in the CallableStatement interface.

CallableStatements can return one or more ResultSets. In the event that multiple ResultSets are returned, they are accessed using the methods inherited from the Statement interface.

Summary

[Expand]

Inherited Constants

From interface java.sql.Statement

Public Methods
abstract Array	getArray(int parameterIndex) Gets the value of a specified JDBC `ARRAY` parameter as a `java.sql.Array`.
abstract Array	getArray(String parameterName) Gets the value of a specified JDBC `ARRAY` parameter as a `java.sql.Array`.
abstract BigDecimal	getBigDecimal(String parameterName) Returns a new `BigDecimal` representation of the JDBC `NUMERIC` parameter specified by the input name.
abstract BigDecimal	getBigDecimal(int parameterIndex, int scale) This method is deprecated. Use `getBigDecimal(int)` or `getBigDecimal(String)`
abstract BigDecimal	getBigDecimal(int parameterIndex) Returns a new `BigDecimal` representation of the JDBC `NUMERIC` parameter specified by the input index.
abstract Blob	getBlob(String parameterName) Gets the value of a specified JDBC `BLOB` parameter as a `java.sql.Blob`.
abstract Blob	getBlob(int parameterIndex) Gets the value of a specified JDBC `BLOB` parameter as a `java.sql.Blob`.
abstract boolean	getBoolean(int parameterIndex) Gets the value of a specified JDBC `BIT` parameter as a boolean.
abstract boolean	getBoolean(String parameterName) Gets the value of a specified JDBC `BIT` parameter as a `boolean`.
abstract byte	getByte(String parameterName) Gets the value of a specified JDBC `TINYINT` parameter as a Java `byte`.
abstract byte	getByte(int parameterIndex) Gets the value of a specified JDBC `TINYINT` parameter as a `byte`.
abstract byte[]	getBytes(int parameterIndex) Returns a byte array representation of the indexed JDBC `BINARY` or `VARBINARY` parameter.
abstract byte[]	getBytes(String parameterName) Returns a byte array representation of the named JDBC `BINARY` or `VARBINARY` parameter.
abstract Reader	getCharacterStream(String parameterName) Returns the value of the specified parameter as a `java.io.Reader`.
abstract Reader	getCharacterStream(int parameterIndex) Returns the value of the specified parameter as a `java.io.Reader`.
abstract Clob	getClob(int parameterIndex) Gets the value of a specified JDBC `CLOB` parameter as a `java.sql.Clob`.
abstract Clob	getClob(String parameterName) Gets the value of a specified JDBC `CLOB` parameter as a `java.sql.Clob`.
abstract Date	getDate(int parameterIndex, Calendar cal) Gets the value of the specified JDBC `DATE` parameter as a `java.sql.Date`, using the specified `Calendar` to construct the date.
abstract Date	getDate(int parameterIndex) Gets the value of the specified JDBC `DATE` parameter as a `java.sql.Date`.
abstract Date	getDate(String parameterName, Calendar cal) Gets the value of the specified JDBC `DATE` parameter as a `java.sql.Date`, using the specified `Calendar` to construct the date.
abstract Date	getDate(String parameterName) Gets the value of the specified JDBC `DATE` parameter as a `java.sql.Date`.
abstract double	getDouble(String parameterName) Gets the value of the specified JDBC `DOUBLE` parameter as a `double`.
abstract double	getDouble(int parameterIndex) Gets the value of the specified JDBC `DOUBLE` parameter as a `double`.
abstract float	getFloat(int parameterIndex) Gets the value of the specified JDBC `FLOAT` parameter as a `float`.
abstract float	getFloat(String parameterName) Gets the value of the specified JDBC `FLOAT` parameter as a Java `float`.
abstract int	getInt(String parameterName) Gets the value of the specified JDBC `INTEGER` parameter as an `int`.
abstract int	getInt(int parameterIndex) Gets the value of the specified JDBC `INTEGER` parameter as an `int`.
abstract long	getLong(String parameterName) Gets the value of the specified JDBC `BIGINT` parameter as a `long`.
abstract long	getLong(int parameterIndex) Gets the value of the specified JDBC `BIGINT` parameter as a `long`.
abstract Reader	getNCharacterStream(int parameterIndex) Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a `Reader`.
abstract Reader	getNCharacterStream(String parameterName) Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a `java.io.Reader`.
abstract NClob	getNClob(String parameterName) Returns the value of the specified SQL NCLOB parameter as a `java.sql.NClob`.
abstract NClob	getNClob(int parameterIndex) Returns the value of the specified SQL NCLOB parameter as a `java.sql.NClob`.
abstract String	getNString(String parameterName) Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a `java.lang.String`.
abstract String	getNString(int parameterIndex) Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a `java.lang.String`.
abstract Object	getObject(String parameterName, Map<String, Class<?>> map) Gets the value of a specified parameter as an `Object`.
abstract Object	getObject(int parameterIndex, Map<String, Class<?>> map) Gets the value of the specified parameter as an `Object`.
abstract Object	getObject(String parameterName) Gets the value of the specified parameter as an `Object`.
abstract Object	getObject(int parameterIndex) Gets the value of the specified parameter as a Java `Object`.
abstract Ref	getRef(String parameterName) Gets the value of a specified SQL `REF()` parameter as a `java.sql.Ref`.
abstract Ref	getRef(int parameterIndex) Gets the value of a specified SQL `REF()` parameter as a `java.sql.Ref`.
abstract RowId	getRowId(String parameterName) Returns the value of the specified SQL ROWID parameter as a `java.sql.RowId`.
abstract RowId	getRowId(int parameterIndex) Gets the value of a specified `ROWID` parameter as a `java.sql.RowId`.
abstract SQLXML	getSQLXML(String parameterName) Returns the value of the specified SQL XML parameter as a `java.sql.SQLXML`.
abstract SQLXML	getSQLXML(int parameterIndex) Returns the value of the specified SQL XML parameter as a `java.sql.SQLXML`.
abstract short	getShort(String parameterName) Gets the value of a specified JDBC `SMALLINT` parameter as a `short`.
abstract short	getShort(int parameterIndex) Gets the value of a specified JDBC `SMALLINT` parameter as a `short`.
abstract String	getString(int parameterIndex) Returns the indexed parameter's value as a `String`.
abstract String	getString(String parameterName) Returns the named parameter's value as a string.
abstract Time	getTime(String parameterName, Calendar cal) Gets the value of a specified JDBC `TIME` parameter as a `java.sql.Time`, using the supplied `Calendar` to construct the time.
abstract Time	getTime(String parameterName) Gets the value of a specified JDBC `TIME` parameter as a `java.sql.Time`.
abstract Time	getTime(int parameterIndex, Calendar cal) Gets the value of a specified JDBC `TIME` parameter as a `java.sql.Time`, using the supplied `Calendar` to construct the time.
abstract Time	getTime(int parameterIndex) Gets the value of a specified JDBC `TIME` parameter as a `java.sql.Time`.
abstract Timestamp	getTimestamp(int parameterIndex, Calendar cal) Returns the indexed parameter's `TIMESTAMP` value as a `java.sql.Timestamp`.
abstract Timestamp	getTimestamp(String parameterName) Returns the named parameter's `TIMESTAMP` value as a `java.sql.Timestamp`.
abstract Timestamp	getTimestamp(String parameterName, Calendar cal) Returns the indexed parameter's `TIMESTAMP` value as a `java.sql.Timestamp`.
abstract Timestamp	getTimestamp(int parameterIndex) Returns the indexed parameter's `TIMESTAMP` value as a `java.sql.Timestamp`.
abstract URL	getURL(int parameterIndex) Gets the value of a specified JDBC `DATALINK` parameter as a `java.net.URL`.
abstract URL	getURL(String parameterName) Returns the named parameter's JDBC `DATALINK` value in a new Java `java.net.URL`.
abstract void	registerOutParameter(String parameterName, int sqlType) Defines the Type of a specified `OUT` parameter.
abstract void	registerOutParameter(int parameterIndex, int sqlType) Defines the type of a specified `OUT` parameter.
abstract void	registerOutParameter(String parameterName, int sqlType, String typeName) Defines the Type of a specified `OUT` parameter.
abstract void	registerOutParameter(String parameterName, int sqlType, int scale) Defines the Type of a specified `OUT` parameter.
abstract void	registerOutParameter(int parameterIndex, int sqlType, int scale) Defines the Type of a specified `OUT` parameter.
abstract void	registerOutParameter(int paramIndex, int sqlType, String typeName) Defines the Type of a specified `OUT` parameter.
abstract void	setAsciiStream(String parameterName, InputStream theInputStream, int length) Sets the value of a specified parameter to the content of a supplied `InputStream`, which has a specified number of bytes.
abstract void	setAsciiStream(String parameterName, InputStream x) Sets the named parameter to the bytes from the given `reader`.
abstract void	setAsciiStream(String parameterName, InputStream x, long length) Sets the named parameter to the next `length` bytes from the given `inputStream`.
abstract void	setBigDecimal(String parameterName, BigDecimal theBigDecimal) Sets the value of a specified parameter to a supplied `java.math.BigDecimal` value.
abstract void	setBinaryStream(String parameterName, InputStream x) Sets the named parameter to the bytes from the given `reader`.
abstract void	setBinaryStream(String parameterName, InputStream x, long length) Sets the named parameter to the next `length` bytes from the given `inputStream`.
abstract void	setBinaryStream(String parameterName, InputStream theInputStream, int length) Sets the value of a specified parameter to the content of a supplied binary `InputStream`, which has a specified number of bytes.
abstract void	setBlob(String parameterName, InputStream inputStream, long length) Sets the named parameter to the next `length` bytes from the given `inputStream`.
abstract void	setBlob(String parameterName, InputStream inputStream) Sets the named parameter to the bytes from the given `inputStream`.
abstract void	setBlob(String parameterName, Blob blob) Sets the named parameter to the given `blob`.
abstract void	setBoolean(String parameterName, boolean theBoolean) Sets the value of a specified parameter to a supplied `boolean` value.
abstract void	setByte(String parameterName, byte theByte) Sets the value of a specified parameter to a supplied `byte` value.
abstract void	setBytes(String parameterName, byte[] theBytes) Sets the value of a specified parameter to a supplied array of bytes.
abstract void	setCharacterStream(String parameterName, Reader reader, int length) Sets the value of a specified parameter to the character content of a `Reader` object, with the specified length of character data.
abstract void	setCharacterStream(String parameterName, Reader reader, long length) Sets the named parameter to the next `length` characters from the given `reader`.
abstract void	setCharacterStream(String parameterName, Reader reader) Sets the named parameter to the characters from the given `reader`.
abstract void	setClob(String parameterName, Reader reader, long length) Sets the named parameter to the next `length` characters from the given `reader`.
abstract void	setClob(String parameterName, Clob clob) Sets the named parameter to the given `clob`.
abstract void	setClob(String parameterName, Reader reader) Sets the named parameter to the characters from the given `reader`.
abstract void	setDate(String parameterName, Date theDate, Calendar cal) Sets the value of a specified parameter to a supplied `java.sql.Date` value, using a supplied calendar to map the date.
abstract void	setDate(String parameterName, Date theDate) Sets the value of a specified parameter to a supplied `java.sql.Date` value.
abstract void	setDouble(String parameterName, double theDouble) Sets the value of a specified parameter to a supplied `double` value.
abstract void	setFloat(String parameterName, float theFloat) Sets the value of a specified parameter to to a supplied `float` value.
abstract void	setInt(String parameterName, int theInt) Sets the value of a specified parameter to a supplied `int` value.
abstract void	setLong(String parameterName, long theLong) Sets the value of a specified parameter to a supplied `long` value.
abstract void	setNCharacterStream(String parameterName, Reader value) Sets the named parameter to the characters from the given `reader`.
abstract void	setNCharacterStream(String parameterName, Reader reader, long length) Sets the named parameter to the characters from the given `reader`.
abstract void	setNClob(String parameterName, Reader reader, long length) Sets the named parameter to the next `length` characters from the given `reader`.
abstract void	setNClob(String parameterName, NClob nclob) Sets the named parameter to the given `nclob`.
abstract void	setNClob(String parameterName, Reader reader) Sets the named parameter to the characters from the given `reader`.
abstract void	setNString(String parameterName, String string) Sets the named parameter to the given `string`.
abstract void	setNull(String parameterName, int sqlType) Sets the value of a specified parameter to SQL `NULL`.
abstract void	setNull(String parameterName, int sqlType, String typeName) Sets the value of a specified parameter to be SQL `NULL` where the parameter type is either `REF` or user defined (e.g.
abstract void	setObject(String parameterName, Object theObject) Sets the value of a specified parameter using a supplied object.
abstract void	setObject(String parameterName, Object theObject, int targetSqlType) Sets the value of a specified parameter using a supplied object.
abstract void	setObject(String parameterName, Object theObject, int targetSqlType, int scale) Sets the value of a specified parameter using a supplied object.
abstract void	setRowId(String parameterName, RowId rowId) Sets the named parameter to the given `rowId`.
abstract void	setSQLXML(String parameterName, SQLXML sqlXml) Sets the named parameter to the given `sqlXml`.
abstract void	setShort(String parameterName, short theShort) Sets the value of a specified parameter to a supplied `short` value.
abstract void	setString(String parameterName, String theString) Sets the value of a specified parameter to a supplied `String`.
abstract void	setTime(String parameterName, Time theTime, Calendar cal) Sets the value of the parameter named `parameterName` to the value of the supplied `java.sql.Time` using the supplied calendar.
abstract void	setTime(String parameterName, Time theTime) Sets the value of the parameter named `parameterName` to the value of the supplied `java.sql.Time`.
abstract void	setTimestamp(String parameterName, Timestamp theTimestamp, Calendar cal) Sets the value of a specified parameter to a supplied `java.sql.Timestamp` value, using the supplied calendar.
abstract void	setTimestamp(String parameterName, Timestamp theTimestamp) Sets the value of a specified parameter to a supplied `java.sql.Timestamp` value.
abstract void	setURL(String parameterName, URL theURL) Sets the value of a specified parameter to the supplied `java.net.URL`.
abstract boolean	wasNull() Gets whether the value of the last `OUT` parameter read was SQL `NULL`.

[Expand]

Inherited Methods

From interface java.sql.PreparedStatement

abstract void	addBatch() Add a set of parameters to the `PreparedStatement`'s command batch.
abstract void	clearParameters() Clear the current parameter values.
abstract boolean	execute() Executes the SQL statement in this `PreparedStatement`.
abstract ResultSet	executeQuery() Executes the SQL query in the `PreparedStatement` and returns the `ResultSet` generated by the query.
abstract int	executeUpdate() Invokes the SQL command contained within the prepared statement.
abstract ResultSetMetaData	getMetaData() Returns a `ResultSetMetaData` describing the `ResultSet` that would be produced by execution of the `PreparedStatement`.
abstract ParameterMetaData	getParameterMetaData() Gets information about the parameters of the `PreparedStatement`.
abstract void	setArray(int parameterIndex, Array theArray) Sets the value of a specified parameter to the supplied `Array`.
abstract void	setAsciiStream(int parameterIndex, InputStream theInputStream, int length) Sets the value of a specified parameter to the content of a supplied `InputStream`, which has a specified number of bytes.
abstract void	setAsciiStream(int parameterIndex, InputStream inputStream) Sets the value of the specified parameter to the bytes from `inputStream`.
abstract void	setAsciiStream(int parameterIndex, InputStream inputStream, long length) Sets the value of the specified parameter to the next `length` bytes from `inputStream`.
abstract void	setBigDecimal(int parameterIndex, BigDecimal theBigDecimal) Sets the value of a specified parameter to a supplied `java.math.BigDecimal` value.
abstract void	setBinaryStream(int parameterIndex, InputStream inputStream) Sets the value of the specified parameter to the bytes from `inputStream`.
abstract void	setBinaryStream(int parameterIndex, InputStream inputStream, long length) Sets the value of the specified parameter to the next `length` bytes from `inputStream`.
abstract void	setBinaryStream(int parameterIndex, InputStream theInputStream, int length) Sets the value of a specified parameter to the content of a supplied binary `InputStream`, which has a specified number of bytes.
abstract void	setBlob(int parameterIndex, InputStream inputStream, long length) Sets the value of the specified parameter to the next `length` bytes from `inputStream`.
abstract void	setBlob(int parameterIndex, InputStream inputStream) Sets the value of the specified parameter to the bytes from `inputStream`.
abstract void	setBlob(int parameterIndex, Blob theBlob) Sets the value of a specified parameter to the given `Blob` object.
abstract void	setBoolean(int parameterIndex, boolean theBoolean) Sets the value of a specified parameter to a supplied `boolean` value.
abstract void	setByte(int parameterIndex, byte theByte) Sets the value of a specified parameter to a supplied `byte` value.
abstract void	setBytes(int parameterIndex, byte[] theBytes) Sets the value of a specified parameter to a supplied array of bytes.
abstract void	setCharacterStream(int parameterIndex, Reader reader) Sets the value of the specified parameter to the characters from `reader`.
abstract void	setCharacterStream(int parameterIndex, Reader reader, int length) Sets the value of a specified parameter to the character content of a `Reader` object, with the specified length of character data.
abstract void	setCharacterStream(int parameterIndex, Reader reader, long length) Sets the value of the specified parameter to the next `length` characters from `reader`.
abstract void	setClob(int parameterIndex, Reader reader) Sets the value of the specified parameter to the characters from `reader`.
abstract void	setClob(int parameterIndex, Reader reader, long length) Sets the value of the specified parameter to the next `length` characters from `reader`.
abstract void	setClob(int parameterIndex, Clob theClob) Sets the value of a specified parameter to the given `Clob` object.
abstract void	setDate(int parameterIndex, Date theDate, Calendar cal) Sets the value of a specified parameter to a supplied `java.sql.Date` value, using a supplied `Calendar` to map the Date.
abstract void	setDate(int parameterIndex, Date theDate) Sets the value of a specified parameter to a supplied `java.sql.Date` value.
abstract void	setDouble(int parameterIndex, double theDouble) Sets the value of a specified parameter to a supplied `double` value.
abstract void	setFloat(int parameterIndex, float theFloat) Sets the value of a specified parameter to to a supplied `float` value.
abstract void	setInt(int parameterIndex, int theInt) Sets the value of a specified parameter to a supplied `int` value.
abstract void	setLong(int parameterIndex, long theLong) Sets the value of a specified parameter to a supplied `long` value.
abstract void	setNCharacterStream(int parameterIndex, Reader reader) Sets the value of the specified parameter to the characters from `reader`.
abstract void	setNCharacterStream(int parameterIndex, Reader reader, long length) Sets the value of the specified parameter to the next `length` characters from `reader`.
abstract void	setNClob(int parameterIndex, Reader reader) Sets the value of the specified parameter to the characters from `reader`.
abstract void	setNClob(int parameterIndex, NClob value) Sets the value of the specified parameter to `value`.
abstract void	setNClob(int parameterIndex, Reader reader, long length) Sets the value of the specified parameter to the next `length` characters from `reader`.
abstract void	setNString(int parameterIndex, String theString) Sets the value of a specified parameter to a supplied string.
abstract void	setNull(int parameterIndex, int sqlType) Sets the value of a specified parameter to SQL `NULL`.
abstract void	setNull(int paramIndex, int sqlType, String typeName) Sets the value of a specified parameter to SQL `NULL`.
abstract void	setObject(int parameterIndex, Object theObject) Sets the value of a specified parameter using a supplied object.
abstract void	setObject(int parameterIndex, Object theObject, int targetSqlType, int scale) Sets the value of a specified parameter using a supplied object.
abstract void	setObject(int parameterIndex, Object theObject, int targetSqlType) Sets the value of a specified parameter using a supplied object.
abstract void	setRef(int parameterIndex, Ref theRef) Sets the value of a specified parameter to a supplied `REF()` value.
abstract void	setRowId(int parameterIndex, RowId theRowId) Sets the value of a specified parameter to a supplied `java.sql.RowId`.
abstract void	setSQLXML(int parameterIndex, SQLXML xmlObject) Sets the value of the specified parameter to the value of `xmlObject`.
abstract void	setShort(int parameterIndex, short theShort) Sets the value of a specified parameter to a supplied `short` value.
abstract void	setString(int parameterIndex, String theString) Sets the value of a specified parameter to a supplied string.
abstract void	setTime(int parameterIndex, Time theTime) Sets the value of a specified parameter to a supplied `java.sql.Time` value.
abstract void	setTime(int parameterIndex, Time theTime, Calendar cal) Sets the value of a specified parameter to a supplied `java.sql.Time` value, using a supplied `Calendar`.
abstract void	setTimestamp(int parameterIndex, Timestamp theTimestamp, Calendar cal) Sets the value of a specified parameter to a supplied `java.sql.Timestamp` value, using the supplied `Calendar`.
abstract void	setTimestamp(int parameterIndex, Timestamp theTimestamp) Sets the value of a specified parameter to a supplied java.sql.Timestamp value.
abstract void	setURL(int parameterIndex, URL theURL) Sets the value of a specified parameter to a supplied `java.net.URL`.
abstract void	setUnicodeStream(int parameterIndex, InputStream theInputStream, int length) This method is deprecated. Use `setCharacterStream(int, Reader, int)`

From interface java.sql.Statement

abstract void	addBatch(String sql) Adds a specified SQL command to the list of commands for this `Statement`.
abstract void	cancel() Cancels this statement's execution if both the database and the JDBC driver support aborting an SQL statement in flight.
abstract void	clearBatch() Clears the current list of SQL commands for this statement.
abstract void	clearWarnings() Clears all `SQLWarnings` from this statement.
abstract void	close() Releases this statement's database and JDBC driver resources.
abstract boolean	execute(String sql) Executes a supplied SQL statement.
abstract boolean	execute(String sql, int autoGeneratedKeys) Executes a supplied SQL statement.
abstract boolean	execute(String sql, String[] columnNames) Executes the supplied SQL statement.
abstract boolean	execute(String sql, int[] columnIndexes) Executes the supplied SQL statement.
abstract int[]	executeBatch() Submits a batch of SQL commands to the database.
abstract ResultSet	executeQuery(String sql) Executes a supplied SQL statement.
abstract int	executeUpdate(String sql, int autoGeneratedKeys) Executes the supplied SQL statement.
abstract int	executeUpdate(String sql, String[] columnNames) Executes the supplied SQL statement.
abstract int	executeUpdate(String sql) Executes the supplied SQL statement.
abstract int	executeUpdate(String sql, int[] columnIndexes) Executes the supplied SQL statement.
abstract Connection	getConnection() Gets the `Connection` object which created this statement.
abstract int	getFetchDirection() Gets the default direction for fetching rows for `ResultSet`s generated from this statement.
abstract int	getFetchSize() Gets the default number of rows for a fetch for the `ResultSet` objects returned from this statement.
abstract ResultSet	getGeneratedKeys() Returns auto generated keys created by executing this statement.
abstract int	getMaxFieldSize() Gets the maximum number of bytes which can be returned as values from character and binary type columns in a `ResultSet` derived from this statement.
abstract int	getMaxRows() Gets the maximum number of rows that a `ResultSet` can contain when produced from this statement.
abstract boolean	getMoreResults(int current) Moves to this statement's next result.
abstract boolean	getMoreResults() Moves to this statement's next result.
abstract int	getQueryTimeout() Gets the timeout value for the statement's execution time.
abstract ResultSet	getResultSet() Gets the current result.
abstract int	getResultSetConcurrency() Gets the concurrency setting for `ResultSet` objects generated by this statement.
abstract int	getResultSetHoldability() Gets the cursor hold setting for `ResultSet` objects generated by this statement.
abstract int	getResultSetType() Gets the `ResultSet` type setting for `ResultSet`s derived from this statement.
abstract int	getUpdateCount() Gets an update count for the current result if it is not a `ResultSet`.
abstract SQLWarning	getWarnings() Retrieves the first `SQLWarning` reported by calls on this statement.
abstract boolean	isClosed() Returns true if this statement has been closed, false otherwise.
abstract boolean	isPoolable() Returns true if this statement is poolable, false otherwise.
abstract void	setCursorName(String name) Sets the SQL cursor name.
abstract void	setEscapeProcessing(boolean enable) Sets Escape Processing mode.
abstract void	setFetchDirection(int direction) Sets the fetch direction - a hint to the JDBC driver about the direction of processing of rows in `ResultSet`s created by this statement.
abstract void	setFetchSize(int rows) Sets the fetch size.
abstract void	setMaxFieldSize(int max) Sets the maximum number of bytes for `ResultSet` columns that contain character or binary values.
abstract void	setMaxRows(int max) Sets the maximum number of rows that any `ResultSet` can contain.
abstract void	setPoolable(boolean poolable) Hints whether this statement should be pooled.
abstract void	setQueryTimeout(int seconds) Sets the timeout, in seconds, for queries - how long the driver will allow for completion of a statement execution.

From interface java.sql.Wrapper

Public Methods

public abstract Array getArray (int parameterIndex)

Since: API Level 1

Gets the value of a specified JDBC ARRAY parameter as a java.sql.Array.

Parameters

parameterIndex	the parameter index, where the first parameter has index 1.

Returns

a java.sql.Array containing the parameter value.

Throws

SQLException	if a database error occurs.

public abstract Array getArray (String parameterName)

Since: API Level 1

Gets the value of a specified JDBC ARRAY parameter as a java.sql.Array.

Parameters

parameterName	the desired parameter's name.

Returns

a java.sql.Array containing the parameter's value.

Throws

SQLException	if there is a problem accessing the database.

public abstract BigDecimal getBigDecimal (String parameterName)

Since: API Level 1

Returns a new BigDecimal representation of the JDBC NUMERIC parameter specified by the input name.

Parameters

parameterName	the desired parameter's name.

Returns

a java.math.BigDecimal representing the value of the specified parameter. The value null is returned if the parameter in question is an SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract BigDecimal getBigDecimal (int parameterIndex, int scale)

Since: API Level 1

This method is deprecated.
Use getBigDecimal(int) or getBigDecimal(String)

Returns a new BigDecimal representation of the JDBC NUMERIC parameter specified by the input index. The number of digits after the decimal point is specified by scale.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.
scale	the number of digits after the decimal point to get.

Returns

a java.math.BigDecimal representing the value of the specified parameter. The value null is returned if the parameter in question is an SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract BigDecimal getBigDecimal (int parameterIndex)

Since: API Level 1

Returns a new BigDecimal representation of the JDBC NUMERIC parameter specified by the input index.

Parameters

parameterIndex	the parameter number index where the first parameter has index 1.

Returns

a java.math.BigDecimal representing the value of the specified parameter. The value null is returned if the parameter in question is an SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Blob getBlob (String parameterName)

Since: API Level 1

Gets the value of a specified JDBC BLOB parameter as a java.sql.Blob.

Parameters

parameterName	the desired parameter's name.

Returns

a java.sql.Blob representing the value of the specified parameter. The value null is returned if the parameter in question is an SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Blob getBlob (int parameterIndex)

Since: API Level 1

Gets the value of a specified JDBC BLOB parameter as a java.sql.Blob.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

a java.sql.Blob representing the value of the specified parameter. The value null is returned if the parameter in question is an SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract boolean getBoolean (int parameterIndex)

Since: API Level 1

Gets the value of a specified JDBC BIT parameter as a boolean.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

a boolean representing the parameter value. false is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract boolean getBoolean (String parameterName)

Since: API Level 1

Gets the value of a specified JDBC BIT parameter as a boolean.

Parameters

parameterName	the desired parameter's name.

Returns

a boolean representation of the value of the parameter. false is returned if the SQL value is NULL.

Throws

SQLException	if a database error occurs.

public abstract byte getByte (String parameterName)

Since: API Level 1

Gets the value of a specified JDBC TINYINT parameter as a Java byte.

Parameters

parameterName	the desired parameter's name.

Returns

a byte representation of the value of the parameter. 0 is returned if the SQL value is NULL.

Throws

SQLException	if a database error occurs.

public abstract byte getByte (int parameterIndex)

Since: API Level 1

Gets the value of a specified JDBC TINYINT parameter as a byte.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

a byte representation of the value of the parameter. 0 is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract byte[] getBytes (int parameterIndex)

Since: API Level 1

Returns a byte array representation of the indexed JDBC BINARY or VARBINARY parameter.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

an array of bytes giving the value of the parameter. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract byte[] getBytes (String parameterName)

Since: API Level 1

Returns a byte array representation of the named JDBC BINARY or VARBINARY parameter.

Parameters

parameterName	the name of the parameter.

Returns

an array of bytes giving the value of the parameter. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Reader getCharacterStream (String parameterName)

Since: API Level 9

Returns the value of the specified parameter as a java.io.Reader.

Parameters

parameterName	the parameter name

Throws

SQLException	if a database error occurs

public abstract Reader getCharacterStream (int parameterIndex)

Since: API Level 9

Returns the value of the specified parameter as a java.io.Reader.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Throws

SQLException	if a database error occurs.

public abstract Clob getClob (int parameterIndex)

Since: API Level 1

Gets the value of a specified JDBC CLOB parameter as a java.sql.Clob.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

a java.sql.Clob representing the value of the parameter. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Clob getClob (String parameterName)

Since: API Level 1

Gets the value of a specified JDBC CLOB parameter as a java.sql.Clob.

Parameters

parameterName	the name of the parameter.

Returns

a java.sql.Clob with the value of the parameter. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Date getDate (int parameterIndex, Calendar cal)

Since: API Level 1

Gets the value of the specified JDBC DATE parameter as a java.sql.Date, using the specified Calendar to construct the date.

The JDBC driver uses the calendar to create the Date using a particular timezone and locale. The default behavior of the driver is to use the Java virtual machine default settings.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.
cal	the `Calendar` to use to construct the date

Returns

the java.sql.Date giving the parameter's value. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Date getDate (int parameterIndex)

Since: API Level 1

Gets the value of the specified JDBC DATE parameter as a java.sql.Date.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

the java.sql.Date representing the parameter's value. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Date getDate (String parameterName, Calendar cal)

Since: API Level 1

Gets the value of the specified JDBC DATE parameter as a java.sql.Date, using the specified Calendar to construct the date.

The JDBC driver uses the calendar to create the date using a particular timezone and locale. The default behavior of the driver is to use the Java virtual machine default settings.

Parameters

parameterName	the name of the desired parameter.
cal	used for creating the returned `Date`.

Returns

the java.sql.Date giving the parameter's value. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Date getDate (String parameterName)

Since: API Level 1

Gets the value of the specified JDBC DATE parameter as a java.sql.Date.

Parameters

parameterName	the name of the desired parameter.

Returns

the java.sql.Date giving the parameter's value. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract double getDouble (String parameterName)

Since: API Level 1

Gets the value of the specified JDBC DOUBLE parameter as a double.

Parameters

parameterName	the name of the desired parameter.

Returns

the parameter's value as a double. 0.0 is returned if the value is SQL NULL.

Throws

SQLException	if there is a problem accessing the database.

public abstract double getDouble (int parameterIndex)

Since: API Level 1

Gets the value of the specified JDBC DOUBLE parameter as a double.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

the parameter's value as a double. 0.0 is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract float getFloat (int parameterIndex)

Since: API Level 1

Gets the value of the specified JDBC FLOAT parameter as a float.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

the parameter's value as a float. 0.0 is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract float getFloat (String parameterName)

Since: API Level 1

Gets the value of the specified JDBC FLOAT parameter as a Java float.

Parameters

parameterName	the name of the desired parameter.

Returns

the parameter's value as a float. 0.0 is returned if the value is SQL NULL.

Throws

SQLException	if there is a problem accessing the database.

public abstract int getInt (String parameterName)

Since: API Level 1

Gets the value of the specified JDBC INTEGER parameter as an int.

Parameters

parameterName	the name of the desired parameter.

Returns

the int giving the parameter's value. 0 is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract int getInt (int parameterIndex)

Since: API Level 1

Gets the value of the specified JDBC INTEGER parameter as an int.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

the int giving the parameter's value. 0 is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract long getLong (String parameterName)

Since: API Level 1

Gets the value of the specified JDBC BIGINT parameter as a long.

Parameters

parameterName	the name of the desired parameter.

Returns

the long giving the parameter's value. 0 is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract long getLong (int parameterIndex)

Since: API Level 1

Gets the value of the specified JDBC BIGINT parameter as a long.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

the long giving the parameter's value. 0 is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Reader getNCharacterStream (int parameterIndex)

Since: API Level 9

Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a Reader.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Throws

SQLException	if a database error occurs.

public abstract Reader getNCharacterStream (String parameterName)

Since: API Level 9

Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a java.io.Reader.

Parameters

parameterName	the parameter name

Throws

SQLException	if a database error occurs

public abstract NClob getNClob (String parameterName)

Since: API Level 9

Returns the value of the specified SQL NCLOB parameter as a java.sql.NClob.

Parameters

parameterName	the parameter name

Throws

SQLException	if a database error occurs

public abstract NClob getNClob (int parameterIndex)

Since: API Level 9

Returns the value of the specified SQL NCLOB parameter as a java.sql.NClob.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Throws

SQLException	if a database error occurs.

public abstract String getNString (String parameterName)

Since: API Level 9

Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a java.lang.String.

Parameters

parameterName	the parameter name

Throws

SQLException	if a database error occurs

public abstract String getNString (int parameterIndex)

Since: API Level 9

Returns the value of the specified SQL NCHAR, NVARCHAR, or LONGNVARCHAR parameter as a java.lang.String.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Gets the value of a specified parameter as an Object. The actual return type is determined by the Map parameter which gives the correspondence between SQL types and Java classes.

Parameters

parameterName	the parameter name.
map	the `Map` of SQL types to their Java counterparts

Returns

an Object holding the value of the parameter.

Throws

SQLException	if there is a problem accessing the database.

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

Since: API Level 1

Gets the value of the specified parameter as an Object. The Map gives the correspondence between SQL types and Java classes.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.
map	the `Map` giving the correspondence between SQL types and Java classes.

Returns

an Object holding the value of the parameter.

Throws

SQLException	if a database error occurs.

public abstract Object getObject (String parameterName)

Since: API Level 1

Gets the value of the specified parameter as an Object.

The object type returned is the JDBC type that was registered for the parameter by an earlier call to registerOutParameter(int, int). If a parameter was registered as a java.sql.Types.OTHER then it may hold abstract types that are particular to the connected database.

Parameters

parameterName	the parameter name.

Returns

the Java Object representation of the value of the parameter.

Throws

SQLException	if there is a problem accessing the database.

public abstract Object getObject (int parameterIndex)

Since: API Level 1

Gets the value of the specified parameter as a Java Object.

The object type returned is the JDBC type registered for the parameter with a registerOutParameter call. If a parameter was registered as a java.sql.Types.OTHER then it may hold abstract types that are particular to the connected database.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

an Object holding the value of the parameter.

Throws

SQLException	if a database error occurs.

public abstract Ref getRef (String parameterName)

Since: API Level 1

Gets the value of a specified SQL REF() parameter as a java.sql.Ref.

Parameters

parameterName	the desired parameter's name.

Returns

the parameter's value in the form of a java.sql.Ref. A null reference is returned if the parameter's value is SQL NULL.

Throws

SQLException	if there is a problem accessing the database.

public abstract Ref getRef (int parameterIndex)

Since: API Level 1

Gets the value of a specified SQL REF() parameter as a java.sql.Ref.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

a java.sql.Ref with the parameter value. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract RowId getRowId (String parameterName)

Since: API Level 9

Returns the value of the specified SQL ROWID parameter as a java.sql.RowId.

Parameters

parameterName	the parameter name

Throws

SQLException	if a database error occurs

public abstract RowId getRowId (int parameterIndex)

Since: API Level 9

Gets the value of a specified ROWID parameter as a java.sql.RowId.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Throws

SQLException	if a database error occurs.

public abstract SQLXML getSQLXML (String parameterName)

Since: API Level 9

Returns the value of the specified SQL XML parameter as a java.sql.SQLXML.

Parameters

parameterName	the parameter name

Throws

SQLException	if a database error occurs

public abstract SQLXML getSQLXML (int parameterIndex)

Since: API Level 9

Returns the value of the specified SQL XML parameter as a java.sql.SQLXML.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Throws

SQLException	if a database error occurs.

public abstract short getShort (String parameterName)

Since: API Level 1

Gets the value of a specified JDBC SMALLINT parameter as a short.

Parameters

parameterName	the desired parameter's name.

Returns

the parameter's value as a short. 0 is returned if the parameter's value is SQL NULL.

Throws

SQLException	if there is a problem accessing the database.

public abstract short getShort (int parameterIndex)

Since: API Level 1

Gets the value of a specified JDBC SMALLINT parameter as a short.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

the parameter's value as a short. 0 is returned if the parameter's value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract String getString (int parameterIndex)

Since: API Level 1

Returns the indexed parameter's value as a String. The parameter value must be one of the JDBC types CHAR, VARCHAR or LONGVARCHAR.

The String corresponding to a CHAR of fixed length will be of identical length to the value in the database inclusive of padding characters.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

the parameter's value as a String. null is returned if the value is SQL NULL.

Throws

SQLException	if there is a problem accessing the database.

public abstract String getString (String parameterName)

Since: API Level 1

Returns the named parameter's value as a string. The parameter value must be one of the JDBC types CHAR, VARCHAR or LONGVARCHAR.

The string corresponding to a CHAR of fixed length will be of identical length to the value in the database inclusive of padding characters.

Parameters

parameterName	the desired parameter's name.

Returns

the parameter's value as a String. null is returned if the value is SQL NULL.

Throws

SQLException	if there is a problem accessing the database.

public abstract Time getTime (String parameterName, Calendar cal)

Since: API Level 1

Gets the value of a specified JDBC TIME parameter as a java.sql.Time, using the supplied Calendar to construct the time. The JDBC driver uses the calendar to handle specific timezones and locales when creating Time.

Parameters

parameterName	the name of the desired parameter.
cal	used for creating the returned `Time`

Returns

a new java.sql.Time with the parameter's value. A null reference is returned for an SQL value of NULL.

Throws

SQLException	if a database error occurs.

public abstract Time getTime (String parameterName)

Since: API Level 1

Gets the value of a specified JDBC TIME parameter as a java.sql.Time.

Parameters

parameterName	the name of the desired parameter.

Returns

a new java.sql.Time with the parameter's value. A null reference is returned for an SQL value of NULL.

Throws

SQLException	if a database error occurs.

public abstract Time getTime (int parameterIndex, Calendar cal)

Since: API Level 1

Gets the value of a specified JDBC TIME parameter as a java.sql.Time, using the supplied Calendar to construct the time. The JDBC driver uses the calendar to handle specific timezones and locales in order to determine Time.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.
cal	the calendar to use in constructing `Time`.

Returns

the parameter's value as a java.sql.Time. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Time getTime (int parameterIndex)

Since: API Level 1

Gets the value of a specified JDBC TIME parameter as a java.sql.Time.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

the parameter's value as a java.sql.Time. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract Timestamp getTimestamp (int parameterIndex, Calendar cal)

Since: API Level 1

Returns the indexed parameter's TIMESTAMP value as a java.sql.Timestamp. The JDBC driver uses the supplied Calendar to handle specific timezones and locales when creating the result.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1
cal	used for creating the returned `Timestamp`

Returns

the parameter's value as a java.sql.Timestamp. A null reference is returned for an SQL value of NULL.

Throws

SQLException	if a database error occurs.

public abstract Timestamp getTimestamp (String parameterName)

Since: API Level 1

Returns the named parameter's TIMESTAMP value as a java.sql.Timestamp.

Parameters

parameterName	the name of the desired parameter.

Returns

the parameter's value as a java.sql.Timestamp. A null reference is returned for an SQL value of NULL.

Throws

SQLException	if a database error occurs.

public abstract Timestamp getTimestamp (String parameterName, Calendar cal)

Since: API Level 1

Returns the indexed parameter's TIMESTAMP value as a java.sql.Timestamp. The JDBC driver uses the supplied Calendar to handle specific timezones and locales when creating the result.

Parameters

parameterName	the name of the desired parameter.
cal	used for creating the returned `Timestamp`

Returns

the parameter's value as a java.sql.Timestamp. A null reference is returned for an SQL value of NULL.

Throws

SQLException	if a database error occurs.

public abstract Timestamp getTimestamp (int parameterIndex)

Since: API Level 1

Returns the indexed parameter's TIMESTAMP value as a java.sql.Timestamp.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1

Returns

the parameter's value as a java.sql.Timestamp. A null reference is returned for an SQL value of NULL.

Throws

SQLException	if a database error occurs.

public abstract URL getURL (int parameterIndex)

Since: API Level 1

Gets the value of a specified JDBC DATALINK parameter as a java.net.URL.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1.

Returns

a URL giving the parameter's value. null is returned if the value is SQL NULL.

Throws

SQLException	if a database error occurs.

public abstract URL getURL (String parameterName)

Since: API Level 1

Returns the named parameter's JDBC DATALINK value in a new Java java.net.URL.

Parameters

parameterName	the name of the desired parameter.

Returns

a new java.net.URL encapsulating the parameter value. A null reference is returned for an SQL value of NULL.

Throws

SQLException	if a database error occurs.

public abstract void registerOutParameter (String parameterName, int sqlType)

Since: API Level 1

Defines the Type of a specified OUT parameter. All OUT parameters must have their Type defined before a stored procedure is executed.

The type supplied in the sqlType parameter fixes the type that will be returned by the getter methods of CallableStatement. If a database-specific type is expected for a parameter, the Type java.sql.Types.OTHER should be used. Note that there is another variant of this method for User Defined Types or a REF type.

Parameters

parameterName	the parameter name.
sqlType	a JDBC type expressed as a constant from `Types`. Types `NUMERIC` and `DECIMAL` should be defined using the variant of this method that takes a `scale` parameter.

Throws

SQLException	if a database error occurs.

public abstract void registerOutParameter (int parameterIndex, int sqlType)

Since: API Level 1

Defines the type of a specified OUT parameter. All OUT parameters must have their type defined before a stored procedure is executed.

The type supplied in the sqlType parameter fixes the type that will be returned by the getter methods of CallableStatement. If a database specific type is expected for a parameter, the Type java.sql.Types.OTHER should be used. Note that there is another variant of this method for User Defined Types or a REF type.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1
sqlType	the JDBC type as defined by `java.sql.Types`. The JDBC types `NUMERIC` and `DECIMAL` should be defined using `registerOutParameter(int, int, int)`.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Defines the Type of a specified OUT parameter. This variant of the method is designed for use with parameters that are User Defined Types (UDT) or a REF type, although it can be used for any type.

Parameters

parameterName	the parameter name
sqlType	a JDBC type expressed as a constant from `Types`
typeName	the fully qualified name of an SQL structured type. For a `REF` type, this name should be the fully qualified name of the referenced type.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Defines the Type of a specified OUT parameter. All OUT parameters must have their Type defined before a stored procedure is executed. This version of the registerOutParameter method, which has a scale parameter, should be used for the JDBC types NUMERIC and DECIMAL, where there is a need to specify the number of digits expected after the decimal point.

The type supplied in the sqlType parameter fixes the type that will be returned by the getter methods of CallableStatement.

Parameters

parameterName	the parameter name.
sqlType	a JDBC type expressed as a constant from `Types`.
scale	the number of digits after the decimal point. Must be greater than or equal to 0.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Defines the Type of a specified OUT parameter. All OUT parameters must have their type defined before a stored procedure is executed. This version of the registerOutParameter method, which has a scale parameter, should be used for the JDBC types NUMERIC and DECIMAL, where there is a need to specify the number of digits expected after the decimal point.

The type supplied in the sqlType parameter fixes the type that will be returned by the getter methods of CallableStatement.

Parameters

parameterIndex	the parameter number index, where the first parameter has index 1
sqlType	the JDBC type as defined by `java.sql.Types`.
scale	the number of digits after the decimal point. Must be greater than or equal to 0.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Defines the Type of a specified OUT parameter. This variant of the method is designed for use with parameters that are User Defined Types (UDT) or a REF type, although it can be used for any type.

Parameters

paramIndex	the parameter number index, where the first parameter has index 1.
sqlType	a JDBC type expressed as a constant from `Types`.
typeName	an SQL type name. For a `REF` type, this name should be the fully qualified name of the referenced type.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Sets the value of a specified parameter to the content of a supplied InputStream, which has a specified number of bytes.

This is a good method for setting an SQL LONGVARCHAR parameter where the length of the data is large. Data is read from the InputStream until end-of-file is reached or the specified number of bytes is copied.

Parameters

parameterName	the parameter name
theInputStream	the ASCII input stream carrying the data to update the parameter with.
length	the number of bytes in the `InputStream` to copy to the parameter.

Throws

SQLException	if a database error occurs.

public abstract void setAsciiStream (String parameterName, InputStream x)

Since: API Level 9

Sets the named parameter to the bytes from the given reader.

Throws

SQLException	if a database error occurs

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

Since: API Level 9

Sets the named parameter to the next length bytes from the given inputStream.

Throws

SQLException	if a database error occurs

public abstract void setBigDecimal (String parameterName, BigDecimal theBigDecimal)

Since: API Level 1

Sets the value of a specified parameter to a supplied java.math.BigDecimal value.

Parameters

parameterName	the name of the parameter.
theBigDecimal	the `java.math.BigInteger` value to set.

Throws

SQLException	if a database error occurs.

public abstract void setBinaryStream (String parameterName, InputStream x)

Since: API Level 9

Sets the named parameter to the bytes from the given reader.

Throws

SQLException	if a database error occurs

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

Since: API Level 9

Sets the named parameter to the next length bytes from the given inputStream.

Throws

SQLException	if a database error occurs

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

Since: API Level 1

Sets the value of a specified parameter to the content of a supplied binary InputStream, which has a specified number of bytes.

Use this method when a large amount of data needs to be set into a LONGVARBINARY parameter.

Parameters

parameterName	the name of the parameter.
theInputStream	the binary `InputStream` carrying the data to update the parameter.
length	the number of bytes in the `InputStream` to copy to the parameter.

Throws

SQLException	if a database error occurs.

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

Since: API Level 9

Sets the named parameter to the next length bytes from the given inputStream.

Throws

SQLException	if a database error occurs

public abstract void setBlob (String parameterName, InputStream inputStream)

Since: API Level 9

Sets the named parameter to the bytes from the given inputStream.

Throws

SQLException	if a database error occurs

public abstract void setBlob (String parameterName, Blob blob)

Since: API Level 9

Sets the named parameter to the given blob.

Throws

SQLException	if a database error occurs

public abstract void setBoolean (String parameterName, boolean theBoolean)

Since: API Level 1

Sets the value of a specified parameter to a supplied boolean value.

Parameters

parameterName	the parameter name.
theBoolean	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

public abstract void setByte (String parameterName, byte theByte)

Since: API Level 1

Sets the value of a specified parameter to a supplied byte value.

Parameters

parameterName	the parameter name.
theByte	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Sets the value of a specified parameter to a supplied array of bytes. The array is mapped to VARBINARY or else LONGVARBINARY in the connected database.

Parameters

parameterName	the parameter name.
theBytes	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Sets the value of a specified parameter to the character content of a Reader object, with the specified length of character data.

Parameters

parameterName	the parameter name.
reader	the new value with which to update the parameter.
length	a count of the characters contained in `reader`.

Throws

SQLException	if a database error occurs.

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

Since: API Level 9

Sets the named parameter to the next length characters from the given reader.

Throws

SQLException	if a database error occurs

public abstract void setCharacterStream (String parameterName, Reader reader)

Since: API Level 9

Sets the named parameter to the characters from the given reader.

Throws

SQLException	if a database error occurs

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

Since: API Level 9

Sets the named parameter to the next length characters from the given reader.

Throws

SQLException	if a database error occurs

public abstract void setClob (String parameterName, Clob clob)

Since: API Level 9

Sets the named parameter to the given clob.

Throws

SQLException	if a database error occurs

public abstract void setClob (String parameterName, Reader reader)

Since: API Level 9

Sets the named parameter to the characters from the given reader.

Throws

SQLException	if a database error occurs

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

Since: API Level 1

Sets the value of a specified parameter to a supplied java.sql.Date value, using a supplied calendar to map the date. The calendar allows the application to control the timezone used to compute the SQL DATE in the database. In case that no calendar is supplied, the driver uses the default timezone of the Java virtual machine.

Parameters

parameterName	the parameter name.
theDate	the new value with which to update the parameter.
cal	a `Calendar` to use to construct the SQL `DATE` value.

Throws

SQLException	if a database error occurs.

public abstract void setDate (String parameterName, Date theDate)

Since: API Level 1

Sets the value of a specified parameter to a supplied java.sql.Date value.

Parameters

parameterName	the parameter name.
theDate	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

public abstract void setDouble (String parameterName, double theDouble)

Since: API Level 1

Sets the value of a specified parameter to a supplied double value.

Parameters

parameterName	the parameter name.
theDouble	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

public abstract void setFloat (String parameterName, float theFloat)

Since: API Level 1

Sets the value of a specified parameter to to a supplied float value.

Parameters

parameterName	the parameter name.
theFloat	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

public abstract void setInt (String parameterName, int theInt)

Since: API Level 1

Sets the value of a specified parameter to a supplied int value.

Parameters

parameterName	the parameter name.
theInt	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

public abstract void setLong (String parameterName, long theLong)

Since: API Level 1

Sets the value of a specified parameter to a supplied long value.

Parameters

parameterName	the parameter name.
theLong	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

public abstract void setNCharacterStream (String parameterName, Reader value)

Since: API Level 9

Sets the named parameter to the characters from the given reader.

Throws

SQLException	if a database error occurs

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

Since: API Level 9

Sets the named parameter to the characters from the given reader.

Throws

SQLException	if a database error occurs

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

Since: API Level 9

Sets the named parameter to the next length characters from the given reader.

Throws

SQLException	if a database error occurs

public abstract void setNClob (String parameterName, NClob nclob)

Since: API Level 9

Sets the named parameter to the given nclob.

Throws

SQLException	if a database error occurs

public abstract void setNClob (String parameterName, Reader reader)

Since: API Level 9

Sets the named parameter to the characters from the given reader.

Throws

SQLException	if a database error occurs

public abstract void setNString (String parameterName, String string)

Since: API Level 9

Sets the named parameter to the given string.

Throws

SQLException	if a database error occurs

public abstract void setNull (String parameterName, int sqlType)

Since: API Level 1

Sets the value of a specified parameter to SQL NULL. Don't use this version of setNull for User Defined Types (UDT) or for REF type parameters.

Parameters

parameterName	the parameter name.
sqlType	a JDBC type expressed as a constant from `Types`.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Sets the value of a specified parameter to be SQL NULL where the parameter type is either REF or user defined (e.g. STRUCT , JAVA_OBJECT etc).

For reasons of portability, the caller is expected to supply both the SQL type code and type name (which is just the parameter name if the type is user defined, referred to as a UDT, or the name of the referenced type in case of a REF type).

Parameters

parameterName	the parameter name.
sqlType	a JDBC type expressed as a constant from `Types`.
typeName	if the target parameter is a user defined type then this should contain the full type name. The fully qualified name of a `UDT` or `REF` type is ignored if the parameter is not a `UDT`.

Throws

SQLException	if a database error occurs.

public abstract void setObject (String parameterName, Object theObject)

Since: API Level 1

Sets the value of a specified parameter using a supplied object. Prior to issuing this request to the connected database theObject is transformed to the corresponding SQL type according to the standard Java to SQL mapping rules.

If the object's class implements the interface SQLData, the JDBC driver calls SQLData.writeSQL to write it to the SQL data stream. If theObject implements any of the following interfaces then the driver is in charge of mapping the value to the appropriate SQL type.

Ref
Struct
Array
Clob
Blob

Parameters

parameterName	the parameter name
theObject	the new value with which to update the parameter

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Sets the value of a specified parameter using a supplied object.

The parameter theObject is converted to the given targetSqlType before it is sent to the database. If the object has a custom mapping (its class implements the interface SQLData), the JDBC driver calls the method SQLData.writeSQL to write it to the SQL data stream. If theObject is an instance of one of the following types

Ref
Struct
Array
Clob
Blob

then the driver is in charge of mapping the value to the appropriate SQL type and deliver it to the database.

Parameters

parameterName	the parameter name.
theObject	the new value with which to update the parameter.
targetSqlType	a JDBC type expressed as a constant from `Types`.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Sets the value of a specified parameter using a supplied object.

The object is converted to the given targetSqlType before it is sent to the database. If the object has a custom mapping (its class implements the interface SQLData), the JDBC driver calls the method SQLData.writeSQL to write it to the SQL data stream. If theObject implements any of the following interfaces

Ref
Struct
Array
Clob
Blob

then the driver is charge of mapping the value to the appropriate SQL type.

Parameters

parameterName	the parameter name.
theObject	the new value with which to update the parameter.
targetSqlType	a JDBC type expressed as a constant from `Types`.
scale	where applicable, the number of digits after the decimal. point.

Throws

SQLException	if a database error occurs.

public abstract void setRowId (String parameterName, RowId rowId)

Since: API Level 9

Sets the named parameter to the given rowId.

Throws

SQLException	if a database error occurs

public abstract void setSQLXML (String parameterName, SQLXML sqlXml)

Since: API Level 9

Sets the named parameter to the given sqlXml.

Throws

SQLException	if a database error occurs

public abstract void setShort (String parameterName, short theShort)

Since: API Level 1

Sets the value of a specified parameter to a supplied short value.

Parameters

parameterName	the name of the parameter.
theShort	a short value to update the parameter.

Throws

SQLException	if a database error occurs.

public abstract void setString (String parameterName, String theString)

Since: API Level 1

Sets the value of a specified parameter to a supplied String.

Parameters

parameterName	the name of the parameter.
theString	a `String` value to update the parameter.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Sets the value of the parameter named parameterName to the value of the supplied java.sql.Time using the supplied calendar.

The driver uses the supplied Calendar to create the SQL TIME value, which allows it to use a custom timezone - otherwise the driver uses the default timezone of the Java virtual machine.

Parameters

parameterName	the parameter name.
theTime	the new value with which to update the parameter.
cal	used for creating the new SQL `TIME` value.

Throws

SQLException	if a database error occurs.

public abstract void setTime (String parameterName, Time theTime)

Since: API Level 1

Sets the value of the parameter named parameterName to the value of the supplied java.sql.Time.

Parameters

parameterName	the parameter name.
theTime	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

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

Since: API Level 1

Sets the value of a specified parameter to a supplied java.sql.Timestamp value, using the supplied calendar.

The driver uses the supplied calendar to create the SQL TIMESTAMP value, which allows it to use a custom timezone - otherwise the driver uses the default timezone of the Java virtual machine.

Parameters

parameterName	the parameter name.
theTimestamp	the new value with which to update the parameter.
cal	used for creating the new SQL `TIME` value.

Throws

SQLException	if a database error occurs.

public abstract void setTimestamp (String parameterName, Timestamp theTimestamp)

Since: API Level 1

Sets the value of a specified parameter to a supplied java.sql.Timestamp value.

Parameters

parameterName	the parameter name.
theTimestamp	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

public abstract void setURL (String parameterName, URL theURL)

Since: API Level 1

Sets the value of a specified parameter to the supplied java.net.URL.

Parameters

parameterName	the parameter name.
theURL	the new value with which to update the parameter.

Throws

SQLException	if a database error occurs.

public abstract boolean wasNull ()

Since: API Level 1

Gets whether the value of the last OUT parameter read was SQL NULL.

Returns

true if the last parameter was SQL NULL, false otherwise.

Throws

SQLException	if a database error occurs.

Interfaces

Classes

Enums

Exceptions

CallableStatement

Class Overview

Summary

Public Methods

public abstract Array getArray (int parameterIndex)

Parameters

Returns

Throws

public abstract Array getArray (String parameterName)

Parameters

Returns

Throws

public abstract BigDecimal getBigDecimal (String parameterName)

Parameters

Returns

Throws

public abstract BigDecimal getBigDecimal (int parameterIndex, int scale)

Parameters

Returns

Throws

public abstract BigDecimal getBigDecimal (int parameterIndex)

Parameters

Returns

Throws

public abstract Blob getBlob (String parameterName)

Parameters

Returns

Throws

public abstract Blob getBlob (int parameterIndex)

Parameters

Returns

Throws

public abstract boolean getBoolean (int parameterIndex)

Parameters

Returns

Throws

public abstract boolean getBoolean (String parameterName)

Parameters

Returns

Throws

public abstract byte getByte (String parameterName)

Parameters

Returns

Throws

public abstract byte getByte (int parameterIndex)

Parameters

Returns

Throws

public abstract byte[] getBytes (int parameterIndex)

Parameters

Returns

Throws

public abstract byte[] getBytes (String parameterName)

Parameters

Returns

Throws

public abstract Reader getCharacterStream (String parameterName)

Parameters

Throws

public abstract Reader getCharacterStream (int parameterIndex)

Parameters

Throws

public abstract Clob getClob (int parameterIndex)

Parameters

Returns

Throws

See Also

public abstract Clob getClob (String parameterName)

Parameters

Returns

Throws

See Also

public abstract Date getDate (int parameterIndex, Calendar cal)

Parameters

Returns

Throws