Home » openjdk-7 » java » sql » [javadoc | source]
java.sql
public interface: CallableStatement [javadoc | source]

All Implemented Interfaces:
    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.

Method from java.sql.CallableStatement Summary:
getArray,   getArray,   getBigDecimal,   getBigDecimal,   getBigDecimal,   getBlob,   getBlob,   getBoolean,   getBoolean,   getByte,   getByte,   getBytes,   getBytes,   getCharacterStream,   getCharacterStream,   getClob,   getClob,   getDate,   getDate,   getDate,   getDate,   getDouble,   getDouble,   getFloat,   getFloat,   getInt,   getInt,   getLong,   getLong,   getNCharacterStream,   getNCharacterStream,   getNClob,   getNClob,   getNString,   getNString,   getObject,   getObject,   getObject,   getObject,   getObject,   getObject,   getRef,   getRef,   getRowId,   getRowId,   getSQLXML,   getSQLXML,   getShort,   getShort,   getString,   getString,   getTime,   getTime,   getTime,   getTime,   getTimestamp,   getTimestamp,   getTimestamp,   getTimestamp,   getURL,   getURL,   registerOutParameter,   registerOutParameter,   registerOutParameter,   registerOutParameter,   registerOutParameter,   registerOutParameter,   setAsciiStream,   setAsciiStream,   setAsciiStream,   setBigDecimal,   setBinaryStream,   setBinaryStream,   setBinaryStream,   setBlob,   setBlob,   setBlob,   setBoolean,   setByte,   setBytes,   setCharacterStream,   setCharacterStream,   setCharacterStream,   setClob,   setClob,   setClob,   setDate,   setDate,   setDouble,   setFloat,   setInt,   setLong,   setNCharacterStream,   setNCharacterStream,   setNClob,   setNClob,   setNClob,   setNString,   setNull,   setNull,   setObject,   setObject,   setObject,   setRowId,   setSQLXML,   setShort,   setString,   setTime,   setTime,   setTimestamp,   setTimestamp,   setURL,   wasNull
Method from java.sql.CallableStatement Detail:
 public Array getArray(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC ARRAY parameter as an
java.sql.Array  object in the Java programming language.
 public Array getArray(String parameterName) throws SQLException
    Retrieves the value of a JDBC ARRAY parameter as an
java.sql.Array  object in the Java programming language.
 public BigDecimal getBigDecimal(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC NUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains.
 public BigDecimal getBigDecimal(String parameterName) throws SQLException
    Retrieves the value of a JDBC NUMERIC parameter as a
java.math.BigDecimal object with as many digits to the
right of the decimal point as the value contains.
 public BigDecimal getBigDecimal(int parameterIndex,
    int scale) throws SQLExceptionDeprecated! use -  getBigDecimal(int parameterIndex)
            or getBigDecimal(String parameterName)

    Retrieves the value of the designated JDBC NUMERIC parameter as a
java.math.BigDecimal object with scale digits to
the right of the decimal point.
 public Blob getBlob(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC BLOB parameter as a
java.sql.Blob  object in the Java programming language.
 public Blob getBlob(String parameterName) throws SQLException
    Retrieves the value of a JDBC BLOB parameter as a
java.sql.Blob  object in the Java programming language.
 public boolean getBoolean(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC BIT
or BOOLEAN parameter as a
boolean in the Java programming language.
 public boolean getBoolean(String parameterName) throws SQLException
    Retrieves the value of a JDBC BIT or BOOLEAN
parameter as a
boolean in the Java programming language.
 public byte getByte(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC TINYINT parameter
as a byte in the Java programming language.
 public byte getByte(String parameterName) throws SQLException
    Retrieves the value of a JDBC TINYINT parameter as a byte
in the Java programming language.
 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.
 public byte[] getBytes(String parameterName) throws SQLException
    Retrieves the value of a JDBC BINARY or VARBINARY
parameter as an array of byte values in the Java
programming language.
 public Reader getCharacterStream(int parameterIndex) throws SQLException
    Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language.
 public Reader getCharacterStream(String parameterName) throws SQLException
    Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language.
 public Clob getClob(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC CLOB parameter as a
java.sql.Clob object in the Java programming language.
 public Clob getClob(String parameterName) throws SQLException
    Retrieves the value of a JDBC CLOB parameter as a
java.sql.Clob object in the Java programming language.
 public Date getDate(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC DATE parameter as a
java.sql.Date object.
 public Date getDate(String parameterName) throws SQLException
    Retrieves the value of a JDBC DATE parameter as a
java.sql.Date object.
 public Date getDate(int parameterIndex,
    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.
 public Date getDate(String parameterName,
    Calendar cal) throws SQLException
    Retrieves the value of a JDBC DATE parameter as a
java.sql.Date object, using
the given Calendar object
to construct the date.
With a Calendar object, the driver
can calculate the date taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.
 public double getDouble(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC DOUBLE parameter as a double
in the Java programming language.
 public double getDouble(String parameterName) throws SQLException
    Retrieves the value of a JDBC DOUBLE parameter as a double
in the Java programming language.
 public float getFloat(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC FLOAT parameter
as a float in the Java programming language.
 public float getFloat(String parameterName) throws SQLException
    Retrieves the value of a JDBC FLOAT parameter as a float
in the Java programming language.
 public int getInt(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC INTEGER parameter
as an int in the Java programming language.
 public int getInt(String parameterName) throws SQLException
    Retrieves the value of a JDBC INTEGER parameter as an int
in the Java programming language.
 public long getLong(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC BIGINT parameter
as a long in the Java programming language.
 public long getLong(String parameterName) throws SQLException
    Retrieves the value of a JDBC BIGINT parameter as a long
in the Java programming language.
 public Reader getNCharacterStream(int parameterIndex) throws SQLException
    Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language.
It is intended for use when
accessing  NCHAR,NVARCHAR
and LONGNVARCHAR parameters.
 public Reader getNCharacterStream(String parameterName) throws SQLException
    Retrieves the value of the designated parameter as a
java.io.Reader object in the Java programming language.
It is intended for use when
accessing  NCHAR,NVARCHAR
and LONGNVARCHAR parameters.
 public NClob getNClob(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC NCLOB parameter as a
java.sql.NClob object in the Java programming language.
 public NClob getNClob(String parameterName) throws SQLException
    Retrieves the value of a JDBC NCLOB parameter as a
java.sql.NClob object in the Java programming language.
 public String getNString(int parameterIndex) throws SQLException
    Retrieves the value of the designated NCHAR,
NVARCHAR
or LONGNVARCHAR parameter as
a String in the Java programming language.
 
    
For the fixed-length type JDBC NCHAR,
the String object
returned has exactly the same value the SQL
NCHAR value had in the
database, including any padding added by the database.
 public String getNString(String parameterName) throws SQLException
    Retrieves the value of the designated NCHAR,
NVARCHAR
or LONGNVARCHAR parameter as
a String in the Java programming language.

    
For the fixed-length type JDBC NCHAR,
the String object
returned has exactly the same value the SQL
NCHAR value had in the
database, including any padding added by the database.
 public 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.
 public Object getObject(String parameterName) throws SQLException
    Retrieves the value of a parameter as an Object in the Java
programming language. If the value is an SQL NULL, the
driver returns a Java null.

    
This method returns a Java object whose type corresponds to the JDBC
type that was registered for this parameter using the method
registerOutParameter.  By registering the target JDBC
type as java.sql.Types.OTHER, this method can be used
to read database-specific abstract data types.
 public Object getObject(int parameterIndex,
    Map<?> map) throws SQLException
    Returns an object representing the value of OUT parameter
parameterIndex and uses map for the custom
mapping of the parameter value.

    
This method returns a Java object whose type corresponds to the
JDBC type that was registered for this parameter using the method
registerOutParameter.  By registering the target
JDBC type as java.sql.Types.OTHER, this method can
be used to read database-specific abstract data types.
 public Object getObject(String parameterName,
    Map<?> map) throws SQLException
    Returns an object representing the value of OUT parameter
parameterName and uses map for the custom
mapping of the parameter value.

    
This method returns a Java object whose type corresponds to the
JDBC type that was registered for this parameter using the method
registerOutParameter.  By registering the target
JDBC type as java.sql.Types.OTHER, this method can
be used to read database-specific abstract data types.
 public T getObject(int parameterIndex,
    Class<T> type) throws SQLException
    Returns an object representing the value of OUT parameter
{@code parameterIndex} and will convert from the
SQL type of the parameter to the requested Java data type, if the
conversion is supported. If the conversion is not
supported or null is specified for the type, a
SQLException is thrown.

    
At a minimum, an implementation must support the conversions defined in
Appendix B, Table B-3 and conversion of appropriate user defined SQL
types to a Java type which implements {@code SQLData}, or {@code Struct}.
Additional conversions may be supported and are vendor defined.
 public T getObject(String parameterName,
    Class<T> type) throws SQLException
    Returns an object representing the value of OUT parameter
{@code parameterName} and will convert from the
SQL type of the parameter to the requested Java data type, if the
conversion is supported. If the conversion is not
supported  or null is specified for the type, a
SQLException is thrown.

    
At a minimum, an implementation must support the conversions defined in
Appendix B, Table B-3 and conversion of appropriate user defined SQL
types to a Java type which implements {@code SQLData}, or {@code Struct}.
Additional conversions may be supported and are vendor defined.
 public Ref getRef(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC REF(<structured-type>)
parameter as a java.sql.Ref  object in the Java programming language.
 public Ref getRef(String parameterName) throws SQLException
    Retrieves the value of a JDBC REF(<structured-type>)
parameter as a java.sql.Ref  object in the Java programming language.
 public RowId getRowId(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC ROWID parameter as a
java.sql.RowId object.
 public RowId getRowId(String parameterName) throws SQLException
    Retrieves the value of the designated JDBC ROWID parameter as a
java.sql.RowId object.
 public SQLXML getSQLXML(int parameterIndex) throws SQLException
    Retrieves the value of the designated SQL XML parameter as a
java.sql.SQLXML object in the Java programming language.
 public SQLXML getSQLXML(String parameterName) throws SQLException
    Retrieves the value of the designated SQL XML parameter as a
java.sql.SQLXML object in the Java programming language.
 public short getShort(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC SMALLINT parameter
as a short in the Java programming language.
 public short getShort(String parameterName) throws SQLException
    Retrieves the value of a JDBC SMALLINT parameter as a short
in the Java programming language.
 public 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 SQL
CHAR value had in the
database, including any padding added by the database.
 public String getString(String parameterName) throws SQLException
    Retrieves the value of a JDBC CHAR, VARCHAR,
or LONGVARCHAR parameter as a String in
the Java programming language.

    
For the fixed-length type JDBC CHAR,
the String object
returned has exactly the same value the SQL
CHAR value had in the
database, including any padding added by the database.
 public Time getTime(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC TIME parameter as a
java.sql.Time object.
 public Time getTime(String parameterName) throws SQLException
    Retrieves the value of a JDBC TIME parameter as a
java.sql.Time object.
 public Time getTime(int parameterIndex,
    Calendar cal) throws SQLException
    Retrieves the value of the designated JDBC TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time.
With a Calendar object, the driver
can calculate the time taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.
 public Time getTime(String parameterName,
    Calendar cal) throws SQLException
    Retrieves the value of a JDBC TIME parameter as a
java.sql.Time object, using
the given Calendar object
to construct the time.
With a Calendar object, the driver
can calculate the time taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.
 public Timestamp getTimestamp(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC TIMESTAMP parameter as a
java.sql.Timestamp object.
 public Timestamp getTimestamp(String parameterName) throws SQLException
    Retrieves the value of a JDBC TIMESTAMP parameter as a
java.sql.Timestamp object.
 public Timestamp getTimestamp(int parameterIndex,
    Calendar cal) throws SQLException
    Retrieves the value of the designated JDBC TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object.
With a Calendar object, the driver
can calculate the timestamp taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.
 public Timestamp getTimestamp(String parameterName,
    Calendar cal) throws SQLException
    Retrieves the value of a JDBC TIMESTAMP parameter as a
java.sql.Timestamp object, using
the given Calendar object to construct
the Timestamp object.
With a Calendar object, the driver
can calculate the timestamp taking into account a custom timezone and locale.
If no Calendar object is specified, the driver uses the
default timezone and locale.
 public URL getURL(int parameterIndex) throws SQLException
    Retrieves the value of the designated JDBC DATALINK parameter as a
java.net.URL object.
 public URL getURL(String parameterName) throws SQLException
    Retrieves the value of a JDBC DATALINK parameter as a
java.net.URL object.
 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  retrieves the value.
 public  void registerOutParameter(String parameterName,
    int sqlType) throws SQLException
    Registers the OUT parameter named
parameterName to the JDBC type
sqlType.  All OUT parameters must be registered
before a stored procedure is executed.

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

    
If the JDBC type expected to be returned to this output parameter
is specific to this particular database, sqlType
should be java.sql.Types.OTHER.  The method
#getObject  retrieves the value.
 public  void registerOutParameter(int parameterIndex,
    int sqlType,
    int scale) throws SQLException
    Registers the parameter in ordinal position
parameterIndex to be of JDBC type
sqlType. All OUT parameters must be registered
before a stored procedure is executed.

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

    
This version of registerOutParameter should be
used when the parameter is of JDBC type NUMERIC
or DECIMAL.
 public  void registerOutParameter(int parameterIndex,
    int sqlType,
    String typeName) throws SQLException
    Registers the designated output parameter.
This version of
the method registerOutParameter
should be used for a user-defined or REF output parameter.  Examples
of user-defined types include: STRUCT, DISTINCT,
JAVA_OBJECT, and named array types.

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

      For a user-defined parameter, the fully-qualified SQL
type name of the parameter should also be given, while a REF
parameter requires that the fully-qualified type name of the
referenced type be given.  A JDBC driver that does not need the
type code and type name information may ignore it.   To be portable,
however, applications should always provide these values for
user-defined and REF parameters.

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


    Note: When reading the value of an out parameter, you
must use the getter method whose Java type corresponds to the
parameter's registered SQL type.
 public  void registerOutParameter(String parameterName,
    int sqlType,
    int scale) throws SQLException
    Registers the parameter named
parameterName to be of JDBC type
sqlType.  All OUT parameters must be registered
before a stored procedure is executed.

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

    
This version of registerOutParameter should be
used when the parameter is of JDBC type NUMERIC
or DECIMAL.
 public  void registerOutParameter(String parameterName,
    int sqlType,
    String typeName) throws SQLException
    Registers the designated output parameter.  This version of
the method registerOutParameter
should be used for a user-named or REF output parameter.  Examples
of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and
named array types.

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

    
For a user-named parameter the fully-qualified SQL
type name of the parameter should also be given, while a REF
parameter requires that the fully-qualified type name of the
referenced type be given.  A JDBC driver that does not need the
type code and type name information may ignore it.   To be portable,
however, applications should always provide these values for
user-named and REF parameters.

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


    Note: When reading the value of an out parameter, you
must use the getXXX method whose Java type XXX corresponds to the
parameter's registered SQL type.
 public  void setAsciiStream(String parameterName,
    InputStream x) throws SQLException
    Sets the designated parameter to the given input stream.
When a very large ASCII value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.InputStream. Data will be read from the stream
as needed until end-of-file is reached.  The JDBC driver will
do any necessary conversion from ASCII to the database char format.


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

    Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setAsciiStream which takes a length parameter.
 public  void setAsciiStream(String parameterName,
    InputStream x,
    int length) throws SQLException
    Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
When a very large ASCII value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.InputStream. Data will be read from the stream
as needed until end-of-file is reached.  The JDBC driver will
do any necessary conversion from ASCII to the database char format.


    Note: This stream object can either be a standard
Java stream object or your own subclass that implements the
standard interface.
 public  void setAsciiStream(String parameterName,
    InputStream x,
    long length) throws SQLException
    Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
When a very large ASCII value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.InputStream. Data will be read from the stream
as needed until end-of-file is reached.  The JDBC driver will
do any necessary conversion from ASCII to the database char format.


    Note: This stream object can either be a standard
Java stream object or your own subclass that implements the
standard interface.
 public  void setBigDecimal(String parameterName,
    BigDecimal x) throws SQLException
    Sets the designated parameter to the given
java.math.BigDecimal value.
The driver converts this to an SQL NUMERIC value when
it sends it to the database.
 public  void setBinaryStream(String parameterName,
    InputStream x) throws SQLException
    Sets the designated parameter to the given input stream.
When a very large binary value is input to a LONGVARBINARY
parameter, it may be more practical to send it via a
java.io.InputStream object. The data will be read from the
stream as needed until end-of-file is reached.


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

    Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBinaryStream which takes a length parameter.
 public  void setBinaryStream(String parameterName,
    InputStream x,
    int length) throws SQLException
    Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
When a very large binary value is input to a LONGVARBINARY
parameter, it may be more practical to send it via a
java.io.InputStream object. The data will be read from the stream
as needed until end-of-file is reached.


    Note: This stream object can either be a standard
Java stream object or your own subclass that implements the
standard interface.
 public  void setBinaryStream(String parameterName,
    InputStream x,
    long length) throws SQLException
    Sets the designated parameter to the given input stream, which will have
the specified number of bytes.
When a very large binary value is input to a LONGVARBINARY
parameter, it may be more practical to send it via a
java.io.InputStream object. The data will be read from the stream
as needed until end-of-file is reached.


    Note: This stream object can either be a standard
Java stream object or your own subclass that implements the
standard interface.
 public  void setBlob(String parameterName,
    Blob x) throws SQLException
    Sets the designated parameter to the given java.sql.Blob object.
The driver converts this to an SQL BLOB value when it
sends it to the database.
 public  void setBlob(String parameterName,
    InputStream inputStream) throws SQLException
    Sets the designated parameter to a InputStream object.
This method differs from the setBinaryStream (int, InputStream)
method because it informs the driver that the parameter value should be
sent to the server as a BLOB.  When the setBinaryStream method is used,
the driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARBINARY or a BLOB


    Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setBlob which takes a length parameter.
 public  void setBlob(String parameterName,
    InputStream inputStream,
    long length) throws SQLException
    Sets the designated parameter to a InputStream object.  The inputstream must contain  the number
of characters specified by length, otherwise a SQLException will be
generated when the CallableStatement is executed.
This method differs from the setBinaryStream (int, InputStream, int)
method because it informs the driver that the parameter value should be
sent to the server as a BLOB.  When the setBinaryStream method is used,
the driver may have to do extra work to determine whether the parameter
data should be sent to the server as a LONGVARBINARY or a BLOB
 public  void setBoolean(String parameterName,
    boolean x) throws SQLException
    Sets the designated parameter to the given Java boolean value.
The driver converts this
to an SQL BIT or BOOLEAN value when it sends it to the database.
 public  void setByte(String parameterName,
    byte x) throws SQLException
    Sets the designated parameter to the given Java byte value.
The driver converts this
to an SQL TINYINT value when it sends it to the database.
 public  void setBytes(String parameterName,
    byte[] x) throws SQLException
    Sets the designated parameter to the given Java array of bytes.
The driver converts this to an SQL VARBINARY or
LONGVARBINARY (depending on the argument's size relative
to the driver's limits on VARBINARY values) when it sends
it to the database.
 public  void setCharacterStream(String parameterName,
    Reader reader) throws SQLException
    Sets the designated parameter to the given Reader
object.
When a very large UNICODE value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.Reader object. The data will be read from the stream
as needed until end-of-file is reached.  The JDBC driver will
do any necessary conversion from UNICODE to the database char format.


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

    Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setCharacterStream which takes a length parameter.
 public  void setCharacterStream(String parameterName,
    Reader reader,
    int length) throws SQLException
    Sets the designated parameter to the given Reader
object, which is the given number of characters long.
When a very large UNICODE value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.Reader object. The data will be read from the stream
as needed until end-of-file is reached.  The JDBC driver will
do any necessary conversion from UNICODE to the database char format.


    Note: This stream object can either be a standard
Java stream object or your own subclass that implements the
standard interface.
 public  void setCharacterStream(String parameterName,
    Reader reader,
    long length) throws SQLException
    Sets the designated parameter to the given Reader
object, which is the given number of characters long.
When a very large UNICODE value is input to a LONGVARCHAR
parameter, it may be more practical to send it via a
java.io.Reader object. The data will be read from the stream
as needed until end-of-file is reached.  The JDBC driver will
do any necessary conversion from UNICODE to the database char format.


    Note: This stream object can either be a standard
Java stream object or your own subclass that implements the
standard interface.
 public  void setClob(String parameterName,
    Clob x) throws SQLException
    Sets the designated parameter to the given java.sql.Clob object.
The driver converts this to an SQL CLOB value when it
sends it to the database.
 public  void setClob(String parameterName,
    Reader reader) throws SQLException
    Sets the designated parameter to a Reader object.
This method differs from the setCharacterStream (int, Reader) method
because it informs the driver that the parameter value should be sent to
the server as a CLOB.  When the setCharacterStream method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARCHAR or a CLOB


    Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setClob which takes a length parameter.
 public  void setClob(String parameterName,
    Reader reader,
    long length) throws SQLException
    Sets the designated parameter to a Reader object.  The reader must contain  the number
of characters specified by length otherwise a SQLException will be
generated when the CallableStatement is executed.
This method differs from the setCharacterStream (int, Reader, int) method
because it informs the driver that the parameter value should be sent to
the server as a CLOB.  When the setCharacterStream method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGVARCHAR or a CLOB
 public  void setDate(String parameterName,
    Date x) throws SQLException
    Sets the designated parameter to the given java.sql.Date value
using the default time zone of the virtual machine that is running
the application.
The driver converts this
to an SQL DATE value when it sends it to the database.
 public  void setDate(String parameterName,
    Date x,
    Calendar cal) throws SQLException
    Sets the designated parameter to the given java.sql.Date value,
using the given Calendar object.  The driver uses
the Calendar object to construct an SQL DATE value,
which the driver then sends to the database.  With a
a Calendar object, the driver can calculate the date
taking into account a custom timezone.  If no
Calendar object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.
 public  void setDouble(String parameterName,
    double x) throws SQLException
    Sets the designated parameter to the given Java double value.
The driver converts this
to an SQL DOUBLE value when it sends it to the database.
 public  void setFloat(String parameterName,
    float x) throws SQLException
    Sets the designated parameter to the given Java float value.
The driver converts this
to an SQL FLOAT value when it sends it to the database.
 public  void setInt(String parameterName,
    int x) throws SQLException
    Sets the designated parameter to the given Java int value.
The driver converts this
to an SQL INTEGER value when it sends it to the database.
 public  void setLong(String parameterName,
    long x) throws SQLException
    Sets the designated parameter to the given Java long value.
The driver converts this
to an SQL BIGINT value when it sends it to the database.
 public  void setNCharacterStream(String parameterName,
    Reader value) throws SQLException
    Sets the designated parameter to a Reader object. The
Reader reads the data till end-of-file is reached. The
driver does the necessary conversion from Java character format to
the national character set in the database.


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

    Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setNCharacterStream which takes a length parameter.
 public  void setNCharacterStream(String parameterName,
    Reader value,
    long length) throws SQLException
    Sets the designated parameter to a Reader object. The
Reader reads the data till end-of-file is reached. The
driver does the necessary conversion from Java character format to
the national character set in the database.
 public  void setNClob(String parameterName,
    NClob value) throws SQLException
    Sets the designated parameter to a java.sql.NClob object. The object
implements the java.sql.NClob interface. This NClob
object maps to a SQL NCLOB.
 public  void setNClob(String parameterName,
    Reader reader) throws SQLException
    Sets the designated parameter to a Reader object.
This method differs from the setCharacterStream (int, Reader) method
because it informs the driver that the parameter value should be sent to
the server as a NCLOB.  When the setCharacterStream method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGNVARCHAR or a NCLOB

    Note: Consult your JDBC driver documentation to determine if
it might be more efficient to use a version of
setNClob which takes a length parameter.
 public  void setNClob(String parameterName,
    Reader reader,
    long length) throws SQLException
    Sets the designated parameter to a Reader object.  The reader must contain  the number
of characters specified by length otherwise a SQLException will be
generated when the CallableStatement is executed.
This method differs from the setCharacterStream (int, Reader, int) method
because it informs the driver that the parameter value should be sent to
the server as a NCLOB.  When the setCharacterStream method is used, the
driver may have to do extra work to determine whether the parameter
data should be send to the server as a LONGNVARCHAR or a NCLOB
 public  void setNString(String parameterName,
    String value) throws SQLException
    Sets the designated parameter to the given String object.
The driver converts this to a SQL NCHAR or
NVARCHAR or LONGNVARCHAR
 public  void setNull(String parameterName,
    int sqlType) throws SQLException
    Sets the designated parameter to SQL NULL.


    Note: You must specify the parameter's SQL type.
 public  void setNull(String parameterName,
    int sqlType,
    String typeName) throws SQLException
    Sets the designated parameter to SQL NULL.
This version of the method setNull should
be used for user-defined types and REF type parameters.  Examples
of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and
named array types.


    Note: To be portable, applications must give the
SQL type code and the fully-qualified SQL type name when specifying
a NULL user-defined or REF parameter.  In the case of a user-defined type
the name is the type name of the parameter itself.  For a REF
parameter, the name is the type name of the referenced type.

    
Although it is intended for user-defined and Ref parameters,
this method may be used to set a null parameter of any JDBC type.
If the parameter does not have a user-defined or REF type, the given
typeName is ignored.
 public  void setObject(String parameterName,
    Object x) throws SQLException
    Sets the value of the designated parameter with the given object.
The second parameter must be of type Object; therefore, the
java.lang equivalent objects should be used for built-in types.


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

    Note that this method may be used to pass datatabase-
specific abstract data types, by using a driver-specific Java
type.

If the object is of a class implementing the interface SQLData,
the JDBC driver should call the method SQLData.writeSQL
to write it to the SQL data stream.
If, on the other hand, the object is of a class implementing
Ref, Blob, Clob,  NClob,
 Struct, java.net.URL,
or Array, the driver should pass it to the database as a
value of the corresponding SQL type.

    
This method throws an exception if there is an ambiguity, for example, if the
object is of a class implementing more than one of the interfaces named above.

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

 public  void setObject(String parameterName,
    Object x,
    int targetSqlType) throws SQLException
    Sets the value of the designated parameter with the given object.
This method is like the method setObject
above, except that it assumes a scale of zero.
 public  void setObject(String parameterName,
    Object x,
    int targetSqlType,
    int scale) throws SQLException
    Sets the value of the designated parameter with the given object. The second
argument must be an object type; for integral values, the
java.lang equivalent objects should be used.


    The given Java object will be converted to the given targetSqlType
before being sent to the database.

If the object has a custom mapping (is of a class implementing the
interface SQLData),
the JDBC driver should call the method SQLData.writeSQL to write it
to the SQL data stream.
If, on the other hand, the object is of a class implementing
Ref, Blob, Clob,  NClob,
 Struct, java.net.URL,
or Array, the driver should pass it to the database as a
value of the corresponding SQL type.

    
Note that this method may be used to pass datatabase-
specific abstract data types.
 public  void setRowId(String parameterName,
    RowId x) throws SQLException
    Sets the designated parameter to the given java.sql.RowId object. The
driver converts this to a SQL ROWID when it sends it to the
database.
 public  void setSQLXML(String parameterName,
    SQLXML xmlObject) throws SQLException
    Sets the designated parameter to the given java.sql.SQLXML object. The driver converts this to an
SQL XML value when it sends it to the database.
 public  void setShort(String parameterName,
    short x) throws SQLException
    Sets the designated parameter to the given Java short value.
The driver converts this
to an SQL SMALLINT value when it sends it to the database.
 public  void setString(String parameterName,
    String x) throws SQLException
    Sets the designated parameter to the given Java String value.
The driver converts this
to an SQL VARCHAR or LONGVARCHAR value
(depending on the argument's
size relative to the driver's limits on VARCHAR values)
when it sends it to the database.
 public  void setTime(String parameterName,
    Time x) throws SQLException
    Sets the designated parameter to the given java.sql.Time value.
The driver converts this
to an SQL TIME value when it sends it to the database.
 public  void setTime(String parameterName,
    Time x,
    Calendar cal) throws SQLException
    Sets the designated parameter to the given java.sql.Time value,
using the given Calendar object.  The driver uses
the Calendar object to construct an SQL TIME value,
which the driver then sends to the database.  With a
a Calendar object, the driver can calculate the time
taking into account a custom timezone.  If no
Calendar object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.
 public  void setTimestamp(String parameterName,
    Timestamp x) throws SQLException
    Sets the designated parameter to the given java.sql.Timestamp value.
The driver
converts this to an SQL TIMESTAMP value when it sends it to the
database.
 public  void setTimestamp(String parameterName,
    Timestamp x,
    Calendar cal) throws SQLException
    Sets the designated parameter to the given java.sql.Timestamp value,
using the given Calendar object.  The driver uses
the Calendar object to construct an SQL TIMESTAMP value,
which the driver then sends to the database.  With a
a Calendar object, the driver can calculate the timestamp
taking into account a custom timezone.  If no
Calendar object is specified, the driver uses the default
timezone, which is that of the virtual machine running the application.
 public  void setURL(String parameterName,
    URL val) throws SQLException
    Sets the designated parameter to the given java.net.URL object.
The driver converts this to an SQL DATALINK value when
it sends it to the database.
 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.