JDBC for CDC/FP Optional Package Specification v1.0: Interface CallableStatement

Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

Copyright © 2006 Sun Microsystems, Inc. All rights reserved.

Overview

Package

Class

Tree

Deprecated

Index

Help

JDBC for CDC/FP Optional Package

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

java.sql
Interface CallableStatement

All Superinterfaces:: PreparedStatement, Statement

public interface CallableStatement
extends PreparedStatement

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:: Connection.prepareCall(java.lang.String), ResultSet

Fields inherited from interface java.sql.Statement

CLOSE_ALL_RESULTS, CLOSE_CURRENT_RESULT, EXECUTE_FAILED, KEEP_CURRENT_RESULT, NO_GENERATED_KEYS, RETURN_GENERATED_KEYS, SUCCESS_NO_INFO

Method Summary

Blob getBlob(int i)
          Retrieves the value of the designated JDBC BLOB parameter as a Blob object in the Java programming language.

boolean getBoolean(int parameterIndex)
          Retrieves the value of the designated JDBC BIT parameter as a boolean in the Java programming language.

byte getByte(int parameterIndex)
          Retrieves the value of the designated JDBC TINYINT parameter as a byte in the Java programming language.

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.

Clob getClob(int i)
          Retrieves the value of the designated JDBC CLOB parameter as a Clob object in the Java programming language.

Date getDate(int parameterIndex)
          Retrieves the value of the designated JDBC DATE parameter as a java.sql.Date object.

Date getDate(int parameterIndex, java.util.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.

double getDouble(int parameterIndex)
          Retrieves the value of the designated JDBC DOUBLE parameter as a double in the Java programming language.

float getFloat(int parameterIndex)
          Retrieves the value of the designated JDBC FLOAT parameter as a float in the Java programming language.

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

long getLong(int parameterIndex)
          Retrieves the value of the designated JDBC BIGINT parameter as a long in the Java programming language.

java.lang.Object getObject(int parameterIndex)
          Retrieves the value of the designated parameter as an Object in the Java programming language.

short getShort(int parameterIndex)
          Retrieves the value of the designated JDBC SMALLINT parameter as a short in the Java programming language.

java.lang.String getString(int parameterIndex)
          Retrieves the value of the designated JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.

Time getTime(int parameterIndex)
          Retrieves the value of the designated JDBC TIME parameter as a java.sql.Time object.

Time getTime(int parameterIndex, java.util.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.

Timestamp getTimestamp(int parameterIndex)
          Retrieves the value of the designated JDBC TIMESTAMP parameter as a java.sql.Timestamp object.

Timestamp getTimestamp(int parameterIndex, java.util.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.

java.net.URL getURL(int parameterIndex)
          Retrieves the value of the designated JDBC DATALINK parameter as a java.net.URL object.

void registerOutParameter(int parameterIndex, int sqlType)
          Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType.

void registerOutParameter(int parameterIndex, int sqlType, int scale)
          Registers the parameter in ordinal position parameterIndex to be of JDBC type sqlType.

void registerOutParameter(int paramIndex, int sqlType, java.lang.String typeName)
          Registers the OUT parameter in ordinal position parameterIndex to the JDBC type sqlType.

boolean wasNull()
          Retrieves whether the last OUT parameter read had the value of SQL NULL.

Methods inherited from interface java.sql.PreparedStatement

addBatch, clearParameters, execute, executeQuery, executeUpdate, getMetaData, setAsciiStream, setBinaryStream, setBlob, setBoolean, setByte, setBytes, setCharacterStream, setClob, setDate, setDate, setDouble, setFloat, setInt, setLong, setNull, setNull, setObject, setObject, setObject, setShort, setString, setTime, setTime, setTimestamp, setTimestamp, setURL

Methods inherited from interface java.sql.Statement

addBatch, cancel, clearBatch, clearWarnings, close, execute, execute, execute, execute, executeBatch, executeQuery, executeUpdate, executeUpdate, executeUpdate, executeUpdate, getConnection, getFetchDirection, getFetchSize, getGeneratedKeys, getMaxFieldSize, getMaxRows, getMoreResults, getMoreResults, getQueryTimeout, getResultSet, getResultSetConcurrency, getResultSetHoldability, getResultSetType, getUpdateCount, getWarnings, setCursorName, setEscapeProcessing, setFetchDirection, setFetchSize, setMaxFieldSize, setMaxRows, setQueryTimeout

Method Detail

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int sqlType)
                          throws SQLException

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 - the first parameter is 1, the second is 2, and so on; sqlType - the JDBC type code defined by java.sql.Types. If the parameter is of JDBC type NUMERIC or DECIMAL, the version of registerOutParameter that accepts a scale value should be used.
Throws:: SQLException - if a database access error occurs
See Also:: Types

registerOutParameter

public void registerOutParameter(int parameterIndex,
                                 int sqlType,
                                 int scale)
                          throws SQLException

Registers the parameter in ordinal position parameterIndex to be of JDBC type sqlType. This method must be called before a stored procedure is executed.

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

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on; sqlType - the SQL type code defined by java.sql.Types.; scale - the desired number of digits to the right of the decimal point. It must be greater than or equal to zero.
Throws:: SQLException - if a database access error occurs
See Also:: Types

wasNull

public boolean wasNull()
                throws SQLException

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

Returns:: true if the last parameter read was SQL NULL; false otherwise
Throws:: SQLException - if a database access error occurs

getString

public java.lang.String getString(int parameterIndex)
                           throws SQLException

Retrieves the value of the designated JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setString(int, java.lang.String)

getBoolean

public boolean getBoolean(int parameterIndex)
                   throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is false.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setBoolean(int, boolean)

getByte

public byte getByte(int parameterIndex)
             throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setByte(int, byte)

getShort

public short getShort(int parameterIndex)
               throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setShort(int, short)

getInt

public int getInt(int parameterIndex)
           throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setInt(int, int)

getLong

public long getLong(int parameterIndex)
             throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setLong(int, long)

getFloat

public float getFloat(int parameterIndex)
               throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setFloat(int, float)

getDouble

public double getDouble(int parameterIndex)
                 throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is 0.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setDouble(int, double)

getBytes

public byte[] getBytes(int parameterIndex)
                throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setBytes(int, byte[])

getDate

public Date getDate(int parameterIndex)
             throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setDate(int, java.sql.Date)

getTime

public Time getTime(int parameterIndex)
             throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setTime(int, java.sql.Time)

getTimestamp

public Timestamp getTimestamp(int parameterIndex)
                       throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: SQLException - if a database access error occurs
See Also:: PreparedStatement.setTimestamp(int, java.sql.Timestamp)

getObject

public java.lang.Object getObject(int parameterIndex)
                           throws SQLException

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

This method returns a Java object whose type corresponds to the JDBC type that was registered for this parameter using the method registerOutParameter. By registering the target JDBC type as java.sql.Types.OTHER, this method can be used to read database-specific abstract data types.

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on
Returns:: A java.lang.Object holding the OUT parameter value
Throws:: SQLException - if a database access error occurs
See Also:: Types, PreparedStatement.setObject(int, java.lang.Object, int, int)

getBlob

public Blob getBlob(int i)
             throws SQLException

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

Parameters:: i - the first parameter is 1, the second is 2, and so on
Returns:: 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 a database access error occurs
Since:: 1.2

getClob

public Clob getClob(int i)
             throws SQLException

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

Parameters:: i - the first parameter is 1, the second is 2, and so on
Returns:: 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 a database access error occurs
Since:: 1.2

getDate

public Date getDate(int parameterIndex,
                    java.util.Calendar cal)
             throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on; cal - the Calendar object the driver will use to construct the date
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: SQLException - if a database access error occurs
Since:: 1.2
See Also:: PreparedStatement.setDate(int, java.sql.Date)

getTime

public Time getTime(int parameterIndex,
                    java.util.Calendar cal)
             throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on; cal - the Calendar object the driver will use to construct the time
Returns:: the parameter value; if the value is SQL NULL, the result is null.
Throws:: SQLException - if a database access error occurs
Since:: 1.2
See Also:: PreparedStatement.setTime(int, java.sql.Time)

getTimestamp

public Timestamp getTimestamp(int parameterIndex,
                              java.util.Calendar cal)
                       throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2, and so on; cal - the Calendar object the driver will use to construct the timestamp
Returns:: the parameter value. If the value is SQL NULL, the result is null.
Throws:: SQLException - if a database access error occurs
Since:: 1.2
See Also:: PreparedStatement.setTimestamp(int, java.sql.Timestamp)

registerOutParameter

public void registerOutParameter(int paramIndex,
                                 int sqlType,
                                 java.lang.String typeName)
                          throws SQLException

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 method getXXX to read the value of that parameter. If the JDBC type expected to be returned to this output parameters is specified to this particular database, sqlType should be java.sql.Types.OTHER. The method CallableStatement.getObject will retrieve the value.

Notes: 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:: paramIndex - the first parameter is 1, the second 2,...; sqlType - a value from Types; typeName - the fully-qualified name of a SQL structured type
Throws:: SQLException - if a database access error occurs
Since:: 1.2
See Also:: Types

getURL

public java.net.URL getURL(int parameterIndex)
                    throws SQLException

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

Parameters:: parameterIndex - the first parameter is 1, the second is 2,...
Returns:: a java.net.URL object that represents the JDBC DATALINK value used as the designated parameter
Throws:: SQLException - if a database access error occurs, or if the URL being returned is not a valid URL on the Java platform
Since:: 1.4
See Also:: PreparedStatement.setURL(int, java.net.URL)

Overview

Package

Class

Tree

Deprecated

Index

Help

JDBC for CDC/FP Optional Package

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to License Terms. Your use of this web site or any of its content or software indicates your agreement to be bound by these License Terms.

For more information, please consult the JSR 169 specification.

Method Summary
`Blob`	`getBlob(int i)` Retrieves the value of the designated JDBC `BLOB` parameter as a `Blob` object in the Java programming language.
`boolean`	`getBoolean(int parameterIndex)` Retrieves the value of the designated JDBC `BIT` parameter as a `boolean` in the Java programming language.
`byte`	`getByte(int parameterIndex)` Retrieves the value of the designated JDBC `TINYINT` parameter as a `byte` in the Java programming language.
`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.
`Clob`	`getClob(int i)` Retrieves the value of the designated JDBC `CLOB` parameter as a `Clob` object in the Java programming language.
`Date`	`getDate(int parameterIndex)` Retrieves the value of the designated JDBC `DATE` parameter as a `java.sql.Date` object.
`Date`	`getDate(int parameterIndex, java.util.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.
`double`	`getDouble(int parameterIndex)` Retrieves the value of the designated JDBC `DOUBLE` parameter as a `double` in the Java programming language.
`float`	`getFloat(int parameterIndex)` Retrieves the value of the designated JDBC `FLOAT` parameter as a `float` in the Java programming language.
`int`	`getInt(int parameterIndex)` Retrieves the value of the designated JDBC `INTEGER` parameter as an `int` in the Java programming language.
`long`	`getLong(int parameterIndex)` Retrieves the value of the designated JDBC `BIGINT` parameter as a `long` in the Java programming language.
`java.lang.Object`	`getObject(int parameterIndex)` Retrieves the value of the designated parameter as an `Object` in the Java programming language.
`short`	`getShort(int parameterIndex)` Retrieves the value of the designated JDBC `SMALLINT` parameter as a `short` in the Java programming language.
`java.lang.String`	`getString(int parameterIndex)` Retrieves the value of the designated JDBC `CHAR`, `VARCHAR`, or `LONGVARCHAR` parameter as a `String` in the Java programming language.
`Time`	`getTime(int parameterIndex)` Retrieves the value of the designated JDBC `TIME` parameter as a `java.sql.Time` object.
`Time`	`getTime(int parameterIndex, java.util.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.
`Timestamp`	`getTimestamp(int parameterIndex)` Retrieves the value of the designated JDBC `TIMESTAMP` parameter as a `java.sql.Timestamp` object.
`Timestamp`	`getTimestamp(int parameterIndex, java.util.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.
`java.net.URL`	`getURL(int parameterIndex)` Retrieves the value of the designated JDBC `DATALINK` parameter as a `java.net.URL` object.
`void`	`registerOutParameter(int parameterIndex, int sqlType)` Registers the OUT parameter in ordinal position `parameterIndex` to the JDBC type `sqlType`.
`void`	`registerOutParameter(int parameterIndex, int sqlType, int scale)` Registers the parameter in ordinal position `parameterIndex` to be of JDBC type `sqlType`.
`void`	`registerOutParameter(int paramIndex, int sqlType, java.lang.String typeName)` Registers the OUT parameter in ordinal position `parameterIndex` to the JDBC type `sqlType`.
`boolean`	`wasNull()` Retrieves whether the last OUT parameter read had the value of SQL `NULL`.

java.sql Interface CallableStatement

registerOutParameter

registerOutParameter

wasNull

getString

getBoolean

getByte

getShort

getInt

getLong

getFloat

getDouble

getBytes

getDate

getTime

getTimestamp

getObject

getBlob

getClob

getDate

getTime

getTimestamp

registerOutParameter

getURL

java.sql
Interface CallableStatement