oracle.jdbc.driver
Class OracleCallableStatement

oracle.jdbc.driver.OracleCallableStatement

public class OracleCallableStatement

Oracle callable statement.

Method Summary

void	addBatch() Add a set of parameters to the batch.
void	clearParameters()
void	close() Close the current result set, if any, and then close the statement.
java.lang.Object	getAnyDataEmbeddedObject(int parameterIndex)
java.sql.Array	getArray(int parameterIndex)
ARRAY	getARRAY(int parameterIndex)
java.sql.Array	getArray(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC ARRAY parameter as an Array object in the Java programming language.
java.io.InputStream	getAsciiStream(int parameterIndex)
BFILE	getBFILE(int parameterIndex)
java.math.BigDecimal	getBigDecimal(int parameterIndex)
java.math.BigDecimal	getBigDecimal(int parameterIndex, int scale)
java.math.BigDecimal	getBigDecimal(java.lang.String parameterName) JDBC 3.0 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.
java.io.InputStream	getBinaryStream(int parameterIndex)
java.sql.Blob	getBlob(int parameterIndex)
BLOB	getBLOB(int parameterIndex)
java.sql.Blob	getBlob(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC BLOB parameter as a Blob object in the Java programming language.
boolean	getBoolean(int parameterIndex)
boolean	getBoolean(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC BIT parameter as a boolean in the Java programming language.
byte	getByte(int parameterIndex)
byte	getByte(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.
byte[]	getBytes(int parameterIndex)
byte[]	getBytes(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
CHAR	getCHAR(int parameterIndex)
java.io.Reader	getCharacterStream(int parameterIndex)
java.sql.Clob	getClob(int parameterIndex)
CLOB	getCLOB(int parameterIndex)
java.sql.Clob	getClob(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC CLOB parameter as a Clob object in the Java programming language.
java.sql.ResultSet	getCursor(int parameterIndex)
java.lang.Object	getCustomDatum(int parameterIndex, CustomDatumFactory factory)
java.sql.Date	getDate(int parameterIndex)
DATE	getDATE(int parameterIndex)
java.sql.Date	getDate(int parameterIndex, java.util.Calendar cal)
java.sql.Date	getDate(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC DATE parameter as a java.sql.Date object.
java.sql.Date	getDate(java.lang.String parameterName, java.util.Calendar cal) JDBC 3.0 Retrieves the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date.
double	getDouble(int parameterIndex)
double	getDouble(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.
float	getFloat(int parameterIndex)
float	getFloat(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.
int	getInt(int parameterIndex)
int	getInt(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.
INTERVALYM	getINTERVALYM(int parameterIndex)
long	getLong(int parameterIndex)
long	getLong(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.
NUMBER	getNUMBER(int parameterIndex)
java.lang.Object	getObject(int parameterIndex)
java.lang.Object	getObject(int parameterIndex, java.util.Map map)
java.lang.Object	getObject(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a parameter as an Object in the Java programming language.
java.lang.Object	getObject(java.lang.String parameterName, java.util.Map map)
OPAQUE	getOPAQUE(int parameterIndex)
Datum	getOracleObject(int parameterIndex)
Datum[]	getOraclePlsqlIndexTable(int paramIndex) Oracle OCI driver specific.
java.lang.Object	getORAData(int parameterIndex, ORADataFactory factory)
java.lang.Object	getPlsqlIndexTable(int paramIndex) Oracle OCI driver specific.
java.lang.Object	getPlsqlIndexTable(int paramIndex, java.lang.Class primitiveType) Oracle OCI driver specific.
RAW	getRAW(int parameterIndex)
java.sql.Ref	getRef(int parameterIndex)
REF	getREF(int parameterIndex)
java.sql.Ref	getRef(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC REF(<structured-type>) parameter as a Ref object in the Java programming language.
ROWID	getROWID(int parameterIndex)
short	getShort(int parameterIndex)
short	getShort(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC SMALLINT parameter as a short in the Java programming language.
java.lang.String	getString(int parameterIndex)
java.lang.String	getString(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
STRUCT	getSTRUCT(int parameterIndex)
java.sql.Time	getTime(int parameterIndex)
java.sql.Time	getTime(int parameterIndex, java.util.Calendar cal)
java.sql.Time	getTime(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC TIME parameter as a java.sql.Time object.
java.sql.Time	getTime(java.lang.String parameterName, java.util.Calendar cal) JDBC 3.0 Retrieves the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time.
java.sql.Timestamp	getTimestamp(int parameterIndex)
TIMESTAMP	getTIMESTAMP(int parameterIndex) To be uncommented when oracle.sql.INTERVALDS is implemented public INTERVALDS getINTERVALDS (int parameterIndex) throws SQLException { return getINTERVALDSValue (false, parameterIndex); }// end of getINTERVALDS (int)
java.sql.Timestamp	getTimestamp(int parameterIndex, java.util.Calendar cal)
java.sql.Timestamp	getTimestamp(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object.
java.sql.Timestamp	getTimestamp(java.lang.String parameterName, java.util.Calendar cal) JDBC 3.0 Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
TIMESTAMPLTZ	getTIMESTAMPLTZ(int parameterIndex)
TIMESTAMPTZ	getTIMESTAMPTZ(int parameterIndex)
java.io.InputStream	getUnicodeStream(int parameterIndex)
java.net.URL	getURL(int parameterIndex) JDBC 3.0 Retrieves the value of the designated JDBC DATALINK parameter as a java.net.URL object.
java.net.URL	getURL(java.lang.String parameterName) JDBC 3.0 Retrieves the value of a JDBC DATALINK parameter as a java.net.URL object.
void	registerIndexTableOutParameter(int paramIndex, int maxLen, int elemSqlType, int elemMaxLen) Oracle OCI driver specific.
void	registerOutParameter(int paramIndex, int sqlType)
void	registerOutParameter(int paramIndex, int sqlType, int scale)
void	registerOutParameter(int paramIndex, int sqlType, int scale, int maxLength) Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns.
void	registerOutParameter(int paramIndex, int sqlType, java.lang.String sqlName) Special Oracle version of registerOutParameter for registering Object columns.
void	registerOutParameter(java.lang.String parameterName, int sqlType) JDBC 3.0 Registers the OUT parameter named parameterName to the JDBC type sqlType.
void	registerOutParameter(java.lang.String parameterName, int sqlType, int scale) JDBC 3.0 Registers the parameter named parameterName to be of JDBC type sqlType.
void	registerOutParameter(java.lang.String parameterName, int sqlType, java.lang.String typeName) JDBC 3.0 Registers the designated output parameter.
void	registerOutParameterBytes(int paramIndex, int sqlType, int scale, int maxLength) Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns.
void	registerOutParameterChars(int paramIndex, int sqlType, int scale, int maxLength) Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns.
int	sendBatch() Send the sets of parameters batched (for Oracle-style batching only).
void	setAsciiStream(java.lang.String parameterName, java.io.InputStream x, int length) JDBC 3.0 Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBigDecimal(java.lang.String parameterName, java.math.BigDecimal x) JDBC 3.0 Sets the designated parameter to the given java.math.BigDecimal value.
void	setBinaryStream(java.lang.String parameterName, java.io.InputStream x, int length) JDBC 3.0 Sets the designated parameter to the given input stream, which will have the specified number of bytes.
void	setBoolean(java.lang.String parameterName, boolean x) JDBC 3.0 Sets the designated parameter to the given Java boolean value.
void	setByte(java.lang.String parameterName, byte x) JDBC 3.0 Sets the designated parameter to the given Java byte value.
void	setBytes(java.lang.String parameterName, byte[] x) JDBC 3.0 Sets the designated parameter to the given Java array of bytes.
void	setCharacterStream(java.lang.String parameterName, java.io.Reader reader, int length) JDBC 3.0 Sets the designated parameter to the given Reader object, which is the given number of characters long.
void	setDate(java.lang.String parameterName, java.sql.Date x) JDBC 3.0 Sets the designated parameter to the given java.sql.Date value.
void	setDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal) JDBC 3.0 Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
void	setDouble(java.lang.String parameterName, double x) JDBC 3.0 Sets the designated parameter to the given Java double value.
void	setExecuteBatch(int nrows) Set the batch value (for Oracle-style batching only).
void	setFloat(java.lang.String parameterName, float x) JDBC 3.0 Sets the designated parameter to the given Java float value.
void	setFormOfUse(int paramIndex, short formOfUse) Sets the "Form Of Use".
void	setInt(java.lang.String parameterName, int x) JDBC 3.0 Sets the designated parameter to the given Java int value.
void	setLong(java.lang.String parameterName, long x) JDBC 3.0 Sets the designated parameter to the given Java long value.
void	setNull(java.lang.String parameterName, int sqlType) JDBC 3.0 Sets the designated parameter to SQL NULL.
void	setObject(java.lang.String parameterName, java.lang.Object x) JDBC 3.0 Sets the value of the designated parameter with the given object.
void	setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType) JDBC 3.0 Sets the value of the designated parameter with the given object.
void	setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType, int scale) JDBC 3.0 Sets the value of the designated parameter with the given object.
void	setShort(java.lang.String parameterName, short x) JDBC 3.0 Sets the designated parameter to the given Java short value.
void	setString(java.lang.String parameterName, java.lang.String x) JDBC 3.0 Sets the designated parameter to the given Java String value.
void	setTime(java.lang.String parameterName, java.sql.Time x) JDBC 3.0 Sets the designated parameter to the given java.sql.Time value.
void	setTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal) JDBC 3.0 Sets the designated parameter to the given java.sql.Time value, using the given Calendar object.
void	setTimestamp(java.lang.String parameterName, java.sql.Timestamp x) JDBC 3.0 Sets the designated parameter to the given java.sql.Timestamp value.
void	setTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal) JDBC 3.0 Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object.
void	setURL(java.lang.String parameterName, java.net.URL val) JDBC 3.0 Sets the designated parameter to the given java.net.URL object.
boolean	wasNull()

Method Detail

registerOutParameter

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

Special Oracle version of registerOutParameter for registering Object columns.

Parameters:

paramIndex - parameter index.

sqlType - use OracleTypes.STRUCT, OracleTypes.ARRAY, OracleTypes.REF, or OracleTypes.OPAQUE.

sqlName - SQL name of the object.

Throws:

java.sql.SQLException - if sqlType is invalid, or an error occurred.

registerOutParameterBytes

public void registerOutParameterBytes(int paramIndex,
                                      int sqlType,
                                      int scale,
                                      int maxLength)
                               throws java.sql.SQLException

Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns. This version accepts a maxLength parameter measured in bytes.

Parameters:

paramIndex - parameter index (the first parameter is 1).

sqlType - type of the bind parameter

scale - not used

maxLength - maximum length of the column, specified in bytes. If not specified, maximum length allowed for that type is used.

Throws:

java.sql.SQLException - if an error occurs (conversion or database-access error)

registerOutParameterChars

public void registerOutParameterChars(int paramIndex,
                                      int sqlType,
                                      int scale,
                                      int maxLength)
                               throws java.sql.SQLException

Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns. This version accepts a maxLength parameter measured in characters.

Parameters:

paramIndex - parameter index (the first parameter is 1).

sqlType - type of the bind parameter

scale - not used

maxLength - maximum length of the column, specified in characters. If not specified, maximum length allowed for that type is used.

Throws:

java.sql.SQLException - if an error occurs (conversion or database-access error)

registerOutParameter

public void registerOutParameter(int paramIndex,
                                 int sqlType,
                                 int scale,
                                 int maxLength)
                          throws java.sql.SQLException

Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns. Depending on the value of OracleConnection.getDataSizeUnits(), maxLength will be measured in bytes or characters.

setExecuteBatch

public void setExecuteBatch(int nrows)
                     throws java.sql.SQLException

Set the batch value (for Oracle-style batching only).

Oracle-style batching is not supported for a callable statement. This method always sets the batch value to 1.

sendBatch

public int sendBatch()
              throws java.sql.SQLException

Send the sets of parameters batched (for Oracle-style batching only).

Oracle-style batching is not supported for a callable statement. This method simply returns the number of valid rows.

registerOutParameter

public void registerOutParameter(int paramIndex,
                                 int sqlType)
                          throws java.sql.SQLException

registerOutParameter

public void registerOutParameter(int paramIndex,
                                 int sqlType,
                                 int scale)
                          throws java.sql.SQLException

wasNull

public boolean wasNull()
                throws java.sql.SQLException

getString

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

getOracleObject

public Datum getOracleObject(int parameterIndex)
                      throws java.sql.SQLException

getROWID

public ROWID getROWID(int parameterIndex)
               throws java.sql.SQLException

getNUMBER

public NUMBER getNUMBER(int parameterIndex)
                 throws java.sql.SQLException

getDATE

public DATE getDATE(int parameterIndex)
             throws java.sql.SQLException

getINTERVALYM

public INTERVALYM getINTERVALYM(int parameterIndex)
                         throws java.sql.SQLException

getTIMESTAMP

public TIMESTAMP getTIMESTAMP(int parameterIndex)
                       throws java.sql.SQLException

To be uncommented when oracle.sql.INTERVALDS is implemented public INTERVALDS getINTERVALDS (int parameterIndex) throws SQLException { return getINTERVALDSValue (false, parameterIndex); }// end of getINTERVALDS (int)

getTIMESTAMPTZ

public TIMESTAMPTZ getTIMESTAMPTZ(int parameterIndex)
                           throws java.sql.SQLException

getTIMESTAMPLTZ

public TIMESTAMPLTZ getTIMESTAMPLTZ(int parameterIndex)
                             throws java.sql.SQLException

getREF

public REF getREF(int parameterIndex)
           throws java.sql.SQLException

getARRAY

public ARRAY getARRAY(int parameterIndex)
               throws java.sql.SQLException

getSTRUCT

public STRUCT getSTRUCT(int parameterIndex)
                 throws java.sql.SQLException

getOPAQUE

public OPAQUE getOPAQUE(int parameterIndex)
                 throws java.sql.SQLException

getCHAR

public CHAR getCHAR(int parameterIndex)
             throws java.sql.SQLException

getCharacterStream

public java.io.Reader getCharacterStream(int parameterIndex)
                                  throws java.sql.SQLException

getRAW

public RAW getRAW(int parameterIndex)
           throws java.sql.SQLException

getBLOB

public BLOB getBLOB(int parameterIndex)
             throws java.sql.SQLException

getCLOB

public CLOB getCLOB(int parameterIndex)
             throws java.sql.SQLException

getBFILE

public BFILE getBFILE(int parameterIndex)
               throws java.sql.SQLException

getBoolean

public boolean getBoolean(int parameterIndex)
                   throws java.sql.SQLException

getByte

public byte getByte(int parameterIndex)
             throws java.sql.SQLException

getShort

public short getShort(int parameterIndex)
               throws java.sql.SQLException

getInt

public int getInt(int parameterIndex)
           throws java.sql.SQLException

getLong

public long getLong(int parameterIndex)
             throws java.sql.SQLException

getFloat

public float getFloat(int parameterIndex)
               throws java.sql.SQLException

getDouble

public double getDouble(int parameterIndex)
                 throws java.sql.SQLException

getBigDecimal

public java.math.BigDecimal getBigDecimal(int parameterIndex,
                                          int scale)
                                   throws java.sql.SQLException

getBytes

public byte[] getBytes(int parameterIndex)
                throws java.sql.SQLException

getDate

public java.sql.Date getDate(int parameterIndex)
                      throws java.sql.SQLException

getTime

public java.sql.Time getTime(int parameterIndex)
                      throws java.sql.SQLException

getTimestamp

public java.sql.Timestamp getTimestamp(int parameterIndex)
                                throws java.sql.SQLException

getAsciiStream

public java.io.InputStream getAsciiStream(int parameterIndex)
                                   throws java.sql.SQLException

getUnicodeStream

public java.io.InputStream getUnicodeStream(int parameterIndex)
                                     throws java.sql.SQLException

getBinaryStream

public java.io.InputStream getBinaryStream(int parameterIndex)
                                    throws java.sql.SQLException

getObject

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

getAnyDataEmbeddedObject

public java.lang.Object getAnyDataEmbeddedObject(int parameterIndex)
                                          throws java.sql.SQLException

getCustomDatum

public java.lang.Object getCustomDatum(int parameterIndex,
                                       CustomDatumFactory factory)
                                throws java.sql.SQLException

getORAData

public java.lang.Object getORAData(int parameterIndex,
                                   ORADataFactory factory)
                            throws java.sql.SQLException

getCursor

public java.sql.ResultSet getCursor(int parameterIndex)
                             throws java.sql.SQLException

clearParameters

public void clearParameters()
                     throws java.sql.SQLException

getObject

public java.lang.Object getObject(int parameterIndex,
                                  java.util.Map map)
                           throws java.sql.SQLException

getRef

public java.sql.Ref getRef(int parameterIndex)
                    throws java.sql.SQLException

getBlob

public java.sql.Blob getBlob(int parameterIndex)
                      throws java.sql.SQLException

getClob

public java.sql.Clob getClob(int parameterIndex)
                      throws java.sql.SQLException

getArray

public java.sql.Array getArray(int parameterIndex)
                        throws java.sql.SQLException

getBigDecimal

public java.math.BigDecimal getBigDecimal(int parameterIndex)
                                   throws java.sql.SQLException

getDate

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

getTime

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

getTimestamp

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

addBatch

public void addBatch()
              throws java.sql.SQLException

Add a set of parameters to the batch.

Throws:

java.sql.SQLException - if an error occurred. Note that stored procedures with out or inout parameters cannot be batched.

Since:

8.1.6 (JDBC 2.0).

close

public void close()
           throws java.sql.SQLException

Close the current result set, if any, and then close the statement.

Throws:

java.sql.SQLException - if error(s) occurred.

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType)
                          throws java.sql.SQLException

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

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

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

Parameters:

parameterName - the name of the parameter

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:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

Types

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType,
                                 int scale)
                          throws java.sql.SQLException

JDBC 3.0 Registers the parameter named parameterName to be of JDBC type sqlType. This method must be called before a stored procedure is executed.

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

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

Parameters:

parameterName - the name of the parameter

sqlType - 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:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

Types

registerOutParameter

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

JDBC 3.0 Registers the designated output parameter. This version of the method registerOutParameter should be used for a user-named or REF output parameter. Examples of user-named types include: STRUCT, DISTINCT, JAVA_OBJECT, and named array types. Before executing a stored procedure call, you must explicitly call registerOutParameter to register the type from java.sql.Types for each OUT parameter. For a user-named parameter the fully-qualified SQL type name of the parameter should also be given, while a REF parameter requires that the fully-qualified type name of the referenced type be given. A JDBC driver that does not need the type code and type name information may ignore it. To be portable, however, applications should always provide these values for user-named and REF parameters. Although it is intended for user-named and REF parameters, this method may be used to register a parameter of any JDBC type. If the parameter does not have a user-named or REF type, the typeName parameter is ignored.

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

Parameters:

parameterName - the name of the parameter

sqlType - a value from java.sql.Types

typeName - the fully-qualified name of an SQL structured type

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

Types

getURL

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

JDBC 3.0 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:

java.sql.SQLException - if a database access error occurs, or if the URL being returned is not a valid URL on the Java platform

Since:

9.0.2

See Also:

setURL(java.lang.String, java.net.URL)

setURL

public void setURL(java.lang.String parameterName,
                   java.net.URL val)
            throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

val - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs, or if a URL is malformed

Since:

9.0.2

See Also:

getURL(int)

setNull

public void setNull(java.lang.String parameterName,
                    int sqlType)
             throws java.sql.SQLException

JDBC 3.0 Sets the designated parameter to SQL NULL.

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

Parameters:

parameterName - the name of the parameter

sqlType - the SQL type code defined in java.sql.Types

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

setBoolean

public void setBoolean(java.lang.String parameterName,
                       boolean x)
                throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getBoolean(int)

setByte

public void setByte(java.lang.String parameterName,
                    byte x)
             throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getByte(int)

setShort

public void setShort(java.lang.String parameterName,
                     short x)
              throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getShort(int)

setInt

public void setInt(java.lang.String parameterName,
                   int x)
            throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getInt(int)

setLong

public void setLong(java.lang.String parameterName,
                    long x)
             throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getLong(int)

setFloat

public void setFloat(java.lang.String parameterName,
                     float x)
              throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getFloat(int)

setDouble

public void setDouble(java.lang.String parameterName,
                      double x)
               throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getDouble(int)

setBigDecimal

public void setBigDecimal(java.lang.String parameterName,
                          java.math.BigDecimal x)
                   throws java.sql.SQLException

JDBC 3.0 Sets the designated parameter to the given java.math.BigDecimal value. The driver converts this to an SQL NUMERIC value when it sends it to the database.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getBigDecimal(int, int)

setString

public void setString(java.lang.String parameterName,
                      java.lang.String x)
               throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getString(int)

setBytes

public void setBytes(java.lang.String parameterName,
                     byte[] x)
              throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getBytes(int)

setDate

public void setDate(java.lang.String parameterName,
                    java.sql.Date x)
             throws java.sql.SQLException

JDBC 3.0 Sets the designated parameter to the given java.sql.Date value. The driver converts this to an SQL DATE value when it sends it to the database.

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getDate(int)

setTime

public void setTime(java.lang.String parameterName,
                    java.sql.Time x)
             throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getTime(int)

setTimestamp

public void setTimestamp(java.lang.String parameterName,
                         java.sql.Timestamp x)
                  throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getTimestamp(int)

setAsciiStream

public void setAsciiStream(java.lang.String parameterName,
                           java.io.InputStream x,
                           int length)
                    throws java.sql.SQLException

JDBC 3.0 Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large ASCII value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.InputStream. Data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from ASCII to the database char format.

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

Parameters:

parameterName - the name of the parameter

x - the Java input stream that contains the ASCII parameter value

length - the number of bytes in the stream

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

setBinaryStream

public void setBinaryStream(java.lang.String parameterName,
                            java.io.InputStream x,
                            int length)
                     throws java.sql.SQLException

JDBC 3.0 Sets the designated parameter to the given input stream, which will have the specified number of bytes. When a very large binary value is input to a LONGVARBINARY parameter, it may be more practical to send it via a java.io.InputStream object. The data will be read from the stream as needed until end-of-file is reached.

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

Parameters:

parameterName - the name of the parameter

x - the java input stream which contains the binary parameter value

length - the number of bytes in the stream

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x,
                      int targetSqlType,
                      int scale)
               throws java.sql.SQLException

JDBC 3.0 Sets the value of the designated parameter with the given object. The second argument must be an object type; for integral values, the java.lang equivalent objects should be used.

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

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

Parameters:

parameterName - the name of the parameter

x - the object containing the input parameter value

targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database. The scale argument may further qualify this type.

scale - for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types, this is the number of digits after the decimal point. For all other types, this value will be ignored.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

Types, getObject(int)

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x,
                      int targetSqlType)
               throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

x - the object containing the input parameter value

targetSqlType - the SQL type (as defined in java.sql.Types) to be sent to the database

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getObject(int)

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x)
               throws java.sql.SQLException

JDBC 3.0 Sets the value of the designated parameter with the given object. The second parameter must be of type Object; therefore, the java.lang equivalent objects should be used for built-in types.

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

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

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

Parameters:

parameterName - the name of the parameter

x - the object containing the input parameter value

Throws:

java.sql.SQLException - if a database access error occurs or if the given Object parameter is ambiguous

Since:

9.0.2

See Also:

getObject(int)

setCharacterStream

public void setCharacterStream(java.lang.String parameterName,
                               java.io.Reader reader,
                               int length)
                        throws java.sql.SQLException

JDBC 3.0 Sets the designated parameter to the given Reader object, which is the given number of characters long. When a very large UNICODE value is input to a LONGVARCHAR parameter, it may be more practical to send it via a java.io.Reader object. The data will be read from the stream as needed until end-of-file is reached. The JDBC driver will do any necessary conversion from UNICODE to the database char format.

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

Parameters:

parameterName - the name of the parameter

reader - the java.io.Reader object that contains the UNICODE data used as the designated parameter

length - the number of characters in the stream

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

setDate

public void setDate(java.lang.String parameterName,
                    java.sql.Date x,
                    java.util.Calendar cal)
             throws java.sql.SQLException

JDBC 3.0 Sets the designated parameter to the given java.sql.Date value, using the given Calendar object. The driver uses the Calendar object to construct an SQL DATE value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the date taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Parameters:

parameterName - the name of the parameter

x - the parameter value

cal - the Calendar object the driver will use to construct the date

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getDate(int)

setTime

public void setTime(java.lang.String parameterName,
                    java.sql.Time x,
                    java.util.Calendar cal)
             throws java.sql.SQLException

JDBC 3.0 Sets the designated parameter to the given java.sql.Time value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIME value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the time taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Parameters:

parameterName - the name of the parameter

x - the parameter value

cal - the Calendar object the driver will use to construct the time

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getTime(int)

setTimestamp

public void setTimestamp(java.lang.String parameterName,
                         java.sql.Timestamp x,
                         java.util.Calendar cal)
                  throws java.sql.SQLException

JDBC 3.0 Sets the designated parameter to the given java.sql.Timestamp value, using the given Calendar object. The driver uses the Calendar object to construct an SQL TIMESTAMP value, which the driver then sends to the database. With a a Calendar object, the driver can calculate the timestamp taking into account a custom timezone. If no Calendar object is specified, the driver uses the default timezone, which is that of the virtual machine running the application.

Parameters:

parameterName - the name of the parameter

x - the parameter value

cal - the Calendar object the driver will use to construct the timestamp

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

getTimestamp(int)

getString

public java.lang.String getString(java.lang.String parameterName)
                           throws java.sql.SQLException

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

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setString(java.lang.String, java.lang.String)

getBoolean

public boolean getBoolean(java.lang.String parameterName)
                   throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is false.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setBoolean(java.lang.String, boolean)

getByte

public byte getByte(java.lang.String parameterName)
             throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setByte(java.lang.String, byte)

getShort

public short getShort(java.lang.String parameterName)
               throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setShort(java.lang.String, short)

getInt

public int getInt(java.lang.String parameterName)
           throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setInt(java.lang.String, int)

getLong

public long getLong(java.lang.String parameterName)
             throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setLong(java.lang.String, long)

getFloat

public float getFloat(java.lang.String parameterName)
               throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setFloat(java.lang.String, float)

getDouble

public double getDouble(java.lang.String parameterName)
                 throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is 0.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setDouble(java.lang.String, double)

getBytes

public byte[] getBytes(java.lang.String parameterName)
                throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setBytes(java.lang.String, byte[])

getDate

public java.sql.Date getDate(java.lang.String parameterName)
                      throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setDate(java.lang.String, java.sql.Date)

getTime

public java.sql.Time getTime(java.lang.String parameterName)
                      throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setTime(java.lang.String, java.sql.Time)

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String parameterName)
                                throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

the parameter value. If the value is SQL NULL, the result is null.

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setTimestamp(java.lang.String, java.sql.Timestamp)

getObject

public java.lang.Object getObject(java.lang.String parameterName)
                           throws java.sql.SQLException

JDBC 3.0 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.

Parameters:

parameterName - the name of the parameter

Returns:

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

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

Types, setObject(java.lang.String, java.lang.Object, int, int)

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String parameterName)
                                   throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

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

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setBigDecimal(java.lang.String, java.math.BigDecimal)

getObject

public java.lang.Object getObject(java.lang.String parameterName,
                                  java.util.Map map)
                           throws java.sql.SQLException

getRef

public java.sql.Ref getRef(java.lang.String parameterName)
                    throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

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

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

getBlob

public java.sql.Blob getBlob(java.lang.String parameterName)
                      throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

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:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

getClob

public java.sql.Clob getClob(java.lang.String parameterName)
                      throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

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:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

getArray

public java.sql.Array getArray(java.lang.String parameterName)
                        throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

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

Throws:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

getDate

public java.sql.Date getDate(java.lang.String parameterName,
                             java.util.Calendar cal)
                      throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

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:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setDate(java.lang.String, java.sql.Date)

getTime

public java.sql.Time getTime(java.lang.String parameterName,
                             java.util.Calendar cal)
                      throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

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:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setTime(java.lang.String, java.sql.Time)

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String parameterName,
                                       java.util.Calendar cal)
                                throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

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:

java.sql.SQLException - if a database access error occurs

Since:

9.0.2

See Also:

setTimestamp(java.lang.String, java.sql.Timestamp)

getURL

public java.net.URL getURL(java.lang.String parameterName)
                    throws java.sql.SQLException

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

Parameters:

parameterName - the name of the parameter

Returns:

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

Throws:

java.sql.SQLException - if a database access error occurs, or if there is a problem with the URL

Since:

9.0.2

See Also:

setURL(java.lang.String, java.net.URL)

registerIndexTableOutParameter

public void registerIndexTableOutParameter(int paramIndex,
                                           int maxLen,
                                           int elemSqlType,
                                           int elemMaxLen)
                                    throws java.sql.SQLException

Oracle OCI driver specific. Special Oracle version of registerOutParameter for registering PLSQL index table parameter.

Parameters:

paramIndex - parameter index.

maxLen - the maximum possible number of elements.

curLen - the current number of elements

elemSqlType - index table element SQL type (as defined in java.sql.Types or OracleTypes).

elemMaxLen - maximum length of the element. If not specified, maximum length allowed for that type is used.

Throws:

java.sql.SQLException - if sqlType is invalid, or an error occurred.

Since:

8.1.7

getPlsqlIndexTable

public java.lang.Object getPlsqlIndexTable(int paramIndex)
                                    throws java.sql.SQLException

Oracle OCI driver specific. Get the value of a PLSQL index table parameter as a Java array. The type of the Java arry will be the default Java object type corresponding to the element's SQL type, following the mapping for built-in types specified in the JDBC spec.

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Returns:

A java.lang.Object holding the parameter value.

Throws:

java.sql.SQLException - if a database-access error occurs.

getPlsqlIndexTable

public java.lang.Object getPlsqlIndexTable(int paramIndex,
                                           java.lang.Class primitiveType)
                                    throws java.sql.SQLException

Oracle OCI driver specific. Get the value of a PLSQL index table parameter as a primitive array. 'primitiveType' speicifies the return array type.

Parameters:

columnIndex - the first column is 1, the second is 2, ...

primitiveType - is a primitive type class. For example,java.lang.Double.Type

Returns:

A java.lang.Object holding the parameter value.

Throws:

java.sql.SQLException - if a database-access error occurs.

getOraclePlsqlIndexTable

public Datum[] getOraclePlsqlIndexTable(int paramIndex)
                                 throws java.sql.SQLException

Oracle OCI driver specific. Get the value of a PLSQL index table parameter as a oracle.sql.Datum array.

Parameters:

columnIndex - the first column is 1, the second is 2, ...

Returns:

A Datum array holding the parameter value.

Throws:

java.sql.SQLException - if a database-access error occurs.

setFormOfUse

public void setFormOfUse(int paramIndex,
                         short formOfUse)

Sets the "Form Of Use". See the javadoc in the interface.