Main Page | Packages | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

org.objectweb.cjdbc.driver.CallableStatement Class Reference

Inheritance diagram for org.objectweb.cjdbc.driver.CallableStatement:

Inheritance graph
[legend]
Collaboration diagram for org.objectweb.cjdbc.driver.CallableStatement:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CallableStatement (Connection connection, String sql) throws SQLException
void registerOutParameter (int parameterIndex, int sqlType) throws SQLException
void registerOutParameter (int parameterIndex, int sqlType, int scale) throws SQLException
boolean wasNull () throws SQLException
String getString (int parameterIndex) throws SQLException
boolean getBoolean (int parameterIndex) throws SQLException
byte getByte (int parameterIndex) throws SQLException
short getShort (int parameterIndex) throws SQLException
int getInt (int parameterIndex) throws SQLException
long getLong (int parameterIndex) throws SQLException
float getFloat (int parameterIndex) throws SQLException
double getDouble (int parameterIndex) throws SQLException
BigDecimal getBigDecimal (int parameterIndex, int scale) throws SQLException
byte[] getBytes (int parameterIndex) throws SQLException
Date getDate (int parameterIndex) throws SQLException
Time getTime (int parameterIndex) throws SQLException
Timestamp getTimestamp (int parameterIndex) throws SQLException
Object getObject (int parameterIndex) throws SQLException
BigDecimal getBigDecimal (int parameterIndex) throws SQLException
Object getObject (int i, Map map) throws SQLException
Ref getRef (int i) throws SQLException
Blob getBlob (int i) throws SQLException
Clob getClob (int i) throws SQLException
Array getArray (int i) throws SQLException
Date getDate (int parameterIndex, Calendar cal) throws SQLException
Time getTime (int parameterIndex, Calendar cal) throws SQLException
Timestamp getTimestamp (int parameterIndex, Calendar cal) throws SQLException
void registerOutParameter (int paramIndex, int sqlType, String typeName) throws SQLException
void registerOutParameter (String parameterName, int sqlType) throws SQLException
void registerOutParameter (String parameterName, int sqlType, int scale) throws SQLException
void registerOutParameter (String parameterName, int sqlType, String typeName) throws SQLException
URL getURL (int parameterIndex) throws SQLException
void setURL (String parameterName, URL val) throws SQLException
void setNull (String parameterName, int sqlType) throws SQLException
void setBoolean (String parameterName, boolean x) throws SQLException
void setByte (String parameterName, byte x) throws SQLException
void setShort (String parameterName, short x) throws SQLException
void setInt (String parameterName, int x) throws SQLException
void setLong (String parameterName, long x) throws SQLException
void setFloat (String parameterName, float x) throws SQLException
void setDouble (String parameterName, double x) throws SQLException
void setBigDecimal (String parameterName, BigDecimal x) throws SQLException
void setString (String parameterName, String x) throws SQLException
void setBytes (String parameterName, byte[] x) throws SQLException
void setDate (String parameterName, Date x) throws SQLException
void setTime (String parameterName, Time x) throws SQLException
void setTimestamp (String parameterName, Timestamp x) throws SQLException
void setAsciiStream (String parameterName, InputStream x, int length) throws SQLException
void setBinaryStream (String parameterName, InputStream x, int length) throws SQLException
void setObject (String parameterName, Object x, int targetSqlType, int scale) throws SQLException
void setObject (String parameterName, Object x, int targetSqlType) throws SQLException
void setObject (String parameterName, Object x) throws SQLException
void setCharacterStream (String parameterName, Reader reader, int length) throws SQLException
void setDate (String parameterName, Date x, Calendar cal) throws SQLException
void setTime (String parameterName, Time x, Calendar cal) throws SQLException
void setTimestamp (String parameterName, Timestamp x, Calendar cal) throws SQLException
void setNull (String parameterName, int sqlType, String typeName) throws SQLException
String getString (String parameterName) throws SQLException
boolean getBoolean (String parameterName) throws SQLException
byte getByte (String parameterName) throws SQLException
short getShort (String parameterName) throws SQLException
int getInt (String parameterName) throws SQLException
long getLong (String parameterName) throws SQLException
float getFloat (String parameterName) throws SQLException
double getDouble (String parameterName) throws SQLException
byte[] getBytes (String parameterName) throws SQLException
Date getDate (String parameterName) throws SQLException
Time getTime (String parameterName) throws SQLException
Timestamp getTimestamp (String parameterName) throws SQLException
Object getObject (String parameterName) throws SQLException
BigDecimal getBigDecimal (String parameterName) throws SQLException
Object getObject (String parameterName, Map map) throws SQLException
Ref getRef (String parameterName) throws SQLException
Blob getBlob (String parameterName) throws SQLException
Clob getClob (String parameterName) throws SQLException
Array getArray (String parameterName) throws SQLException
Date getDate (String parameterName, Calendar cal) throws SQLException
Time getTime (String parameterName, Calendar cal) throws SQLException
Timestamp getTimestamp (String parameterName, Calendar cal) throws SQLException
URL getURL (String parameterName) throws SQLException

Detailed Description

This class is 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. The only syntax accepted by this implementation is as follows:

  {call <procedure-name>[<arg1>,<arg2>, ...]}

The other standard form

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

is *NOT* supported. Parameters are referred to sequentially, by number, with the first parameter being 1. IN parameter values are set using the set methods inherited from PreparedStatement.

OUT parameters are *NOT* supported.

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

See also:
org.objectweb.cjdbc.driver.Connection.prepareCall(String)

DriverResultSet

Author:
Emmanuel Cecchet
Version:
1.0

Definition at line 76 of file CallableStatement.java.

Constructor & Destructor Documentation

org.objectweb.cjdbc.driver.CallableStatement.CallableStatement (  Connection  connection,
String  sql
)  throws SQLException
 

CallableStatements syntax is {call procedure_name[(?, ?, ...)]}. Note that {? = call ...} is not supported by this implementation.

Parameters:
connection the instanatiating connection
sql the SQL statement with ? for IN markers
Exceptions:
SQLException if something bad occurs

Definition at line 88 of file CallableStatement.java.

00090   {
00091     super(connection, sql);
00092     if (!this.sql.toLowerCase().startsWith("{call")
00093         && !this.sql.toLowerCase().startsWith("}call"))
00094       throw new SQLException(
00095           "Syntax error: callable statements expected syntax is {call procedure_name[(?, ?, ...)]}");
00096   }

Member Function Documentation

Array org.objectweb.cjdbc.driver.CallableStatement.getArray (  String  parameterName  )  throws SQLException
 

Retrieves the value of a JDBC ARRAY parameter as an Arrayobject 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.
Exceptions:
SQLException if a database access error occurs
Since:
1.4

Definition at line 1560 of file CallableStatement.java.

01561   {
01562     throw new NotImplementedException("getArray");
01563   }

Array org.objectweb.cjdbc.driver.CallableStatement.getArray (  int  i  )  throws SQLException
 

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

Parameters:
i the first parameter is 1, the second is 2, and so on
Returns:
the parameter value as an Array object in the Java programming language. If the value was SQL NULL, the value null is returned.
Exceptions:
SQLException if a database access error occurs
Since:
1.2

Definition at line 502 of file CallableStatement.java.

00503   {
00504     throw new NotImplementedException("getArray");
00505   }

BigDecimal org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
Returns:
the parameter value in full precision. If the value is SQL NULL, the result is null.
Exceptions:
SQLException if a database access error occurs
See also:
setBigDecimal
Since:
1.4

Definition at line 1474 of file CallableStatement.java.

01475   {
01476     throw new NotImplementedException("getBigDecimal");
01477   }

BigDecimal org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value in full precision. If the value is SQL NULL, the result is null.
Exceptions:
SQLException if a database access error occurs
See also:
setBigDecimal
Since:
1.2

Definition at line 415 of file CallableStatement.java.

00416   {
00417     throw new NotImplementedException("");
00418   }

BigDecimal org.objectweb.cjdbc.driver.CallableStatement.getBigDecimal (  int  parameterIndex,
int  scale
)  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
scale the number of digits to the right of the decimal point
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Exceptions:
SQLException if a database access error occurs

Deprecated:
use getBigDecimal(int parameterIndex) or getBigDecimal(String parameterName)
See also:
setBigDecimal

Definition at line 309 of file CallableStatement.java.

00311   {
00312     throw new NotImplementedException("getBigDecimal");
00313   }

Blob org.objectweb.cjdbc.driver.CallableStatement.getBlob (  String  parameterName  )  throws SQLException
 

Retrieves the value of a JDBC BLOB parameter as a Blobobject 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.
Exceptions:
SQLException if a database access error occurs
Since:
1.4

Definition at line 1528 of file CallableStatement.java.

01529   {
01530     throw new NotImplementedException("getBlob");
01531   }

Blob org.objectweb.cjdbc.driver.CallableStatement.getBlob (  int  i  )  throws SQLException
 

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

Parameters:
i the first parameter is 1, the second is 2, and so on
Returns:
the parameter value as a Blob object in the Java programming language. If the value was SQL NULL, the value null is returned.
Exceptions:
SQLException if a database access error occurs
Since:
1.2

Definition at line 470 of file CallableStatement.java.

00471   {
00472     throw new NotImplementedException("getBlob");
00473   }

boolean org.objectweb.cjdbc.driver.CallableStatement.getBoolean (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
See also:
setBoolean
Since:
1.4

Definition at line 1273 of file CallableStatement.java.

01274   {
01275     throw new NotImplementedException("getBoolean");
01276   }

boolean org.objectweb.cjdbc.driver.CallableStatement.getBoolean (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is false.
Exceptions:
SQLException if a database access error occurs
See also:
setBoolean

Definition at line 200 of file CallableStatement.java.

00201   {
00202     throw new NotImplementedException("getBoolean");
00203   }

byte org.objectweb.cjdbc.driver.CallableStatement.getByte (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
See also:
setByte
Since:
1.4

Definition at line 1289 of file CallableStatement.java.

01290   {
01291     throw new NotImplementedException("getByte");
01292   }

byte org.objectweb.cjdbc.driver.CallableStatement.getByte (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Exceptions:
SQLException if a database access error occurs
See also:
setByte

Definition at line 215 of file CallableStatement.java.

00216   {
00217     throw new NotImplementedException("getByte");
00218   }

byte [] org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Exceptions:
SQLException if a database access error occurs
See also:
setBytes
Since:
1.4

Definition at line 1386 of file CallableStatement.java.

01387   {
01388     throw new NotImplementedException("getBytes");
01389   }

byte [] org.objectweb.cjdbc.driver.CallableStatement.getBytes (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Exceptions:
SQLException if a database access error occurs
See also:
setBytes

Definition at line 326 of file CallableStatement.java.

00327   {
00328     throw new NotImplementedException("getBytes");
00329   }

Clob org.objectweb.cjdbc.driver.CallableStatement.getClob (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
Since:
1.4

Definition at line 1544 of file CallableStatement.java.

01545   {
01546     throw new NotImplementedException("getClob");
01547   }

Clob org.objectweb.cjdbc.driver.CallableStatement.getClob (  int  i  )  throws SQLException
 

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

Parameters:
i the first parameter is 1, the second is 2, and so on
Returns:
the parameter value as a Clob object in the Java programming language. If the value was SQL NULL, the value null is returned.
Exceptions:
SQLException if a database access error occurs
Since:
1.2

Definition at line 486 of file CallableStatement.java.

00487   {
00488     throw new NotImplementedException("getClob");
00489   }

Date org.objectweb.cjdbc.driver.CallableStatement.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.

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.
Exceptions:
SQLException if a database access error occurs
See also:
setDate(String, Date, Calendar)
Since:
1.4

Definition at line 1582 of file CallableStatement.java.

01583   {
01584     throw new NotImplementedException("getDate");
01585   }

Date org.objectweb.cjdbc.driver.CallableStatement.getDate (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
See also:
setDate(String, Date)
Since:
1.4

Definition at line 1402 of file CallableStatement.java.

01403   {
01404     throw new NotImplementedException("getDate");
01405   }

Date org.objectweb.cjdbc.driver.CallableStatement.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.

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

Definition at line 524 of file CallableStatement.java.

00525   {
00526     throw new NotImplementedException("getDate");
00527   }

Date org.objectweb.cjdbc.driver.CallableStatement.getDate (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Exceptions:
SQLException if a database access error occurs
See also:
setDate(String, Date)

Definition at line 341 of file CallableStatement.java.

00342   {
00343     throw new NotImplementedException("getDate");
00344   }

double org.objectweb.cjdbc.driver.CallableStatement.getDouble (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
See also:
setDouble
Since:
1.4

Definition at line 1369 of file CallableStatement.java.

01370   {
01371     throw new NotImplementedException("getDouble");
01372   }

double org.objectweb.cjdbc.driver.CallableStatement.getDouble (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Exceptions:
SQLException if a database access error occurs
See also:
setDouble

Definition at line 290 of file CallableStatement.java.

00291   {
00292     throw new NotImplementedException("getDouble");
00293   }

float org.objectweb.cjdbc.driver.CallableStatement.getFloat (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
See also:
setFloat
Since:
1.4

Definition at line 1353 of file CallableStatement.java.

01354   {
01355     throw new NotImplementedException("getFloat");
01356   }

float org.objectweb.cjdbc.driver.CallableStatement.getFloat (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Exceptions:
SQLException if a database access error occurs
See also:
setFloat

Definition at line 275 of file CallableStatement.java.

00276   {
00277     throw new NotImplementedException("getFloat");
00278   }

int org.objectweb.cjdbc.driver.CallableStatement.getInt (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
See also:
setInt
Since:
1.4

Definition at line 1321 of file CallableStatement.java.

01322   {
01323     throw new NotImplementedException("getInt");
01324   }

int org.objectweb.cjdbc.driver.CallableStatement.getInt (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Exceptions:
SQLException if a database access error occurs
See also:
setInt

Definition at line 245 of file CallableStatement.java.

00246   {
00247     throw new NotImplementedException("getInt");
00248   }

long org.objectweb.cjdbc.driver.CallableStatement.getLong (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
See also:
setLong
Since:
1.4

Definition at line 1337 of file CallableStatement.java.

01338   {
01339     throw new NotImplementedException("getLong");
01340   }

long org.objectweb.cjdbc.driver.CallableStatement.getLong (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Exceptions:
SQLException if a database access error occurs
See also:
setLong

Definition at line 260 of file CallableStatement.java.

00261   {
00262     throw new NotImplementedException("getLong");
00263   }

Object org.objectweb.cjdbc.driver.CallableStatement.getObject (  String  parameterName,
Map  map
)  throws SQLException
 

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

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

Parameters:
parameterName the name of the parameter
map the mapping from SQL type names to Java classes
Returns:
a java.lang.Object holding the OUT parameter value
Exceptions:
SQLException if a database access error occurs
See also:
setObject(String, Object)
Since:
1.4

Definition at line 1496 of file CallableStatement.java.

01497   {
01498     throw new NotImplementedException("getObject");
01499   }

Object org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
Returns:
A java.lang.Object holding the OUT parameter value.
Exceptions:
SQLException if a database access error occurs
See also:
java.sql.Types

setObject(String, Object)

Since:
1.4

Definition at line 1457 of file CallableStatement.java.

01458   {
01459     throw new NotImplementedException("getObject");
01460   }

Object org.objectweb.cjdbc.driver.CallableStatement.getObject (  int  i,
Map  map
)  throws SQLException
 

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

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

Parameters:
i the first parameter is 1, the second is 2, and so on
map the mapping from SQL type names to Java classes
Returns:
a java.lang.Object holding the OUT parameter value
Exceptions:
SQLException if a database access error occurs
See also:
setObject(String, Object)
Since:
1.2

Definition at line 437 of file CallableStatement.java.

00438   {
00439     throw new NotImplementedException("getObject");
00440   }

Object org.objectweb.cjdbc.driver.CallableStatement.getObject (  int  parameterIndex  )  throws SQLException
 

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

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
A java.lang.Object holding the OUT parameter value
Exceptions:
SQLException if a database access error occurs
See also:
java.sql.Types

setObject(String, Object)

Definition at line 396 of file CallableStatement.java.

00397   {
00398     throw new NotImplementedException("getObject");
00399   }

Ref org.objectweb.cjdbc.driver.CallableStatement.getRef (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
Since:
1.4

Definition at line 1512 of file CallableStatement.java.

01513   {
01514     throw new NotImplementedException("getRef");
01515   }

Ref org.objectweb.cjdbc.driver.CallableStatement.getRef (  int  i  )  throws SQLException
 

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

Parameters:
i the first parameter is 1, the second is 2, and so on
Returns:
the parameter value as a Ref object in the Java programming language. If the value was SQL NULL, the value null is returned.
Exceptions:
SQLException if a database access error occurs
Since:
1.2

Definition at line 454 of file CallableStatement.java.

00455   {
00456     throw new NotImplementedException("getRef");
00457   }

short org.objectweb.cjdbc.driver.CallableStatement.getShort (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
See also:
setShort
Since:
1.4

Definition at line 1305 of file CallableStatement.java.

01306   {
01307     throw new NotImplementedException("getShort");
01308   }

short org.objectweb.cjdbc.driver.CallableStatement.getShort (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is 0.
Exceptions:
SQLException if a database access error occurs
See also:
setShort

Definition at line 230 of file CallableStatement.java.

00231   {
00232     throw new NotImplementedException("getShort");
00233   }

String org.objectweb.cjdbc.driver.CallableStatement.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 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.
Exceptions:
SQLException if a database access error occurs
See also:
setString
Since:
1.4

Definition at line 1257 of file CallableStatement.java.

01258   {
01259     throw new NotImplementedException("getString");
01260   }

String org.objectweb.cjdbc.driver.CallableStatement.getString (  int  parameterIndex  )  throws SQLException
 

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

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Exceptions:
SQLException if a database access error occurs
See also:
setString

Definition at line 185 of file CallableStatement.java.

00186   {
00187     throw new NotImplementedException("getString");
00188   }

Time org.objectweb.cjdbc.driver.CallableStatement.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.

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.
Exceptions:
SQLException if a database access error occurs
See also:
setTime(String, Time, Calendar)
Since:
1.4

Definition at line 1604 of file CallableStatement.java.

01605   {
01606     throw new NotImplementedException("getTime");
01607   }

Time org.objectweb.cjdbc.driver.CallableStatement.getTime (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
See also:
setTime(String, Time)
Since:
1.4

Definition at line 1418 of file CallableStatement.java.

01419   {
01420     throw new NotImplementedException("getTime");
01421   }

Time org.objectweb.cjdbc.driver.CallableStatement.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.

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

Definition at line 546 of file CallableStatement.java.

00547   {
00548     throw new NotImplementedException("getTime");
00549   }

Time org.objectweb.cjdbc.driver.CallableStatement.getTime (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Exceptions:
SQLException if a database access error occurs
See also:
setTime(String, Time)

Definition at line 356 of file CallableStatement.java.

00357   {
00358     throw new NotImplementedException("getTime");
00359   }

Timestamp org.objectweb.cjdbc.driver.CallableStatement.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.

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.
Exceptions:
SQLException if a database access error occurs
See also:
setTimestamp(String, Timestamp, Calendar)
Since:
1.4

Definition at line 1627 of file CallableStatement.java.

01629   {
01630     throw new NotImplementedException("getTimestamp");
01631   }

Timestamp org.objectweb.cjdbc.driver.CallableStatement.getTimestamp (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
See also:
setTimestamp(String, Timestamp)
Since:
1.4

Definition at line 1434 of file CallableStatement.java.

01435   {
01436     throw new NotImplementedException("getTimestamp");
01437   }

Timestamp org.objectweb.cjdbc.driver.CallableStatement.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.

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

Definition at line 569 of file CallableStatement.java.

00571   {
00572     throw new NotImplementedException("getTimestamp");
00573   }

Timestamp org.objectweb.cjdbc.driver.CallableStatement.getTimestamp (  int  parameterIndex  )  throws SQLException
 

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
Returns:
the parameter value. If the value is SQL NULL, the result is null.
Exceptions:
SQLException if a database access error occurs
See also:
setTimestamp(String, Timestamp)

Definition at line 371 of file CallableStatement.java.

00372   {
00373     throw new NotImplementedException("getTimestamp");
00374   }

URL org.objectweb.cjdbc.driver.CallableStatement.getURL (  String  parameterName  )  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs, or if there is a problem with the URL
See also:
setURL
Since:
1.4

Definition at line 1646 of file CallableStatement.java.

01647   {
01648     throw new NotImplementedException("getURL");
01649   }

URL org.objectweb.cjdbc.driver.CallableStatement.getURL (  int  parameterIndex  )  throws SQLException
 

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

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

Definition at line 721 of file CallableStatement.java.

00722   {
00723     throw new NotImplementedException("getURL");
00724   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

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
Exceptions:
SQLException if a database access error occurs
See also:
java.sql.Types
Since:
1.4

Definition at line 703 of file CallableStatement.java.

00705   {
00706     throw new NotImplementedException("registerOutParameter");
00707   }

void org.objectweb.cjdbc.driver.CallableStatement.registerOutParameter (  String  parameterName,
int  sqlType,
int  scale
)  throws SQLException
 

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.
Exceptions:
SQLException if a database access error occurs
Since:
1.4
See also:
java.sql.Types

Definition at line 666 of file CallableStatement.java.

00668   {
00669     throw new NotImplementedException("registerOutParameter");
00670   }

void org.objectweb.cjdbc.driver.CallableStatement.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(String) 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.
Exceptions:
SQLException if a database access error occurs
Since:
1.4
See also:
java.sql.Types

Definition at line 640 of file CallableStatement.java.

00642   {
00643     throw new NotImplementedException("registerOutParameter");
00644   }

void org.objectweb.cjdbc.driver.CallableStatement.registerOutParameter (  int  paramIndex,
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.

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

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

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

Parameters:
paramIndex the first parameter is 1, the second is 2,...
sqlType a value from java.sql.Types
typeName the fully-qualified name of an SQL structured type
Exceptions:
SQLException if a database access error occurs
See also:
java.sql.Types
Since:
1.2

Definition at line 608 of file CallableStatement.java.

00610   {
00611     throw new NotImplementedException("registerOutParameter");
00612   }

void org.objectweb.cjdbc.driver.CallableStatement.registerOutParameter (  int  parameterIndex,
int  sqlType,
int  scale
)  throws SQLException
 

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

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

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

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

Definition at line 147 of file CallableStatement.java.

00149   {
00150     throw new NotImplementedException(
00151         "registerOutParameter(int parameterIndex, int sqlType, int scale)");
00152   }

void org.objectweb.cjdbc.driver.CallableStatement.registerOutParameter (  int  parameterIndex,
int  sqlType
)  throws SQLException
 

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

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

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

Parameters:
parameterIndex the first parameter is 1, the second is 2, and so on
sqlType the JDBC type code defined by java.sql.Types. If the parameter is of JDBC type NUMERIC or DECIMAL, the version of registerOutParameter that accepts a scale value should be used.
Exceptions:
SQLException if a database access error occurs
See also:
java.sql.Types

Definition at line 121 of file CallableStatement.java.

00123   {
00124     throw new NotImplementedException(
00125         "registerOutParameter(int parameterIndex, int sqlType)");
00126   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

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
Exceptions:
SQLException if a database access error occurs
Since:
1.4

Definition at line 989 of file CallableStatement.java.

00991   {
00992     throw new NotImplementedException("setAsciiStream");
00993   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getBigDecimal(String)
Since:
1.4

Definition at line 881 of file CallableStatement.java.

00883   {
00884     throw new NotImplementedException("setBigDecimal");
00885   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

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
Exceptions:
SQLException if a database access error occurs
Since:
1.4

Definition at line 1011 of file CallableStatement.java.

01013   {
01014     throw new NotImplementedException("setBinaryStream");
01015   }

void org.objectweb.cjdbc.driver.CallableStatement.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 value when it sends it to the database.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getBoolean(String)
Since:
1.4

Definition at line 769 of file CallableStatement.java.

00770   {
00771     throw new NotImplementedException("setBoolean");
00772   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getByte(String)
Since:
1.4

Definition at line 785 of file CallableStatement.java.

00786   {
00787     throw new NotImplementedException("setByte");
00788   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getBytes(String)
Since:
1.4

Definition at line 918 of file CallableStatement.java.

00919   {
00920     throw new NotImplementedException("setBytes");
00921   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

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
Exceptions:
SQLException if a database access error occurs
Since:
1.4

Definition at line 1131 of file CallableStatement.java.

01133   {
01134     throw new NotImplementedException("");
01135   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
cal the Calendar object the driver will use to construct the date
Exceptions:
SQLException if a database access error occurs
See also:
getDate(String, Calendar)
Since:
1.4

Definition at line 1155 of file CallableStatement.java.

01157   {
01158     throw new NotImplementedException("setDate");
01159   }

void org.objectweb.cjdbc.driver.CallableStatement.setDate (  String  parameterName,
Date  x
)  throws SQLException
 

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
Exceptions:
SQLException if a database access error occurs
See also:
getDate(String)
Since:
1.4

Definition at line 934 of file CallableStatement.java.

00935   {
00936     throw new NotImplementedException("setDate");
00937   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getDouble(String)
Since:
1.4

Definition at line 865 of file CallableStatement.java.

00866   {
00867     throw new NotImplementedException("setDouble");
00868   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getFloat(String)
Since:
1.4

Definition at line 849 of file CallableStatement.java.

00850   {
00851     throw new NotImplementedException("setFloat");
00852   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getInt(String)
Since:
1.4

Definition at line 817 of file CallableStatement.java.

00818   {
00819     throw new NotImplementedException("setInt");
00820   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getLong(String)
Since:
1.4

Definition at line 833 of file CallableStatement.java.

00834   {
00835     throw new NotImplementedException("setLong");
00836   }

void org.objectweb.cjdbc.driver.CallableStatement.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. If a JDBC driver does not need the type code or type name information, it may ignore it.

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

Parameters:
parameterName the name of the parameter
sqlType a value from java.sql.Types
typeName the fully-qualified name of an SQL user-defined type; ignored if the parameter is not a user-defined type or SQL REF value
Exceptions:
SQLException if a database access error occurs
Since:
1.4

Definition at line 1234 of file CallableStatement.java.

01236   {
01237     throw new NotImplementedException("setNull");
01238   }

void org.objectweb.cjdbc.driver.CallableStatement.setNull (  String  parameterName,
int  sqlType
)  throws SQLException
 

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
Exceptions:
SQLException if a database access error occurs
Since:
1.4

Definition at line 753 of file CallableStatement.java.

00754   {
00755     throw new NotImplementedException("setNull");
00756   }

void org.objectweb.cjdbc.driver.CallableStatement.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,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
Exceptions:
SQLException if a database access error occurs or if the given Object parameter is ambiguous
See also:
getObject(String, Map)
Since:
1.4

Definition at line 1107 of file CallableStatement.java.

01108   {
01109     throw new NotImplementedException("setObject");
01110   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

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
Exceptions:
SQLException if a database access error occurs
See also:
getObject(String, Map)
Since:
1.4

Definition at line 1069 of file CallableStatement.java.

01071   {
01072     throw new NotImplementedException("setObject");
01073   }

void org.objectweb.cjdbc.driver.CallableStatement.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,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.
Exceptions:
SQLException if a database access error occurs
See also:
java.sql.Types

getObject(String, Map)

Since:
1.4

Definition at line 1050 of file CallableStatement.java.

01052   {
01053     throw new NotImplementedException("setObject");
01054   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getShort(String)
Since:
1.4

Definition at line 801 of file CallableStatement.java.

00802   {
00803     throw new NotImplementedException("setShort");
00804   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getString(String)
Since:
1.4

Definition at line 900 of file CallableStatement.java.

00901   {
00902     throw new NotImplementedException("setString");
00903   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
cal the Calendar object the driver will use to construct the time
Exceptions:
SQLException if a database access error occurs
See also:
getTime(String, Calendar)
Since:
1.4

Definition at line 1179 of file CallableStatement.java.

01181   {
01182     throw new NotImplementedException("setTime");
01183   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getTime(String)
Since:
1.4

Definition at line 950 of file CallableStatement.java.

00951   {
00952     throw new NotImplementedException("setTime");
00953   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
cal the Calendar object the driver will use to construct the timestamp
Exceptions:
SQLException if a database access error occurs
See also:
getTimestamp(String, Calendar)
Since:
1.4

Definition at line 1203 of file CallableStatement.java.

01205   {
01206     throw new NotImplementedException("setTimestamp");
01207   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
x the parameter value
Exceptions:
SQLException if a database access error occurs
See also:
getTimestamp(String)
Since:
1.4

Definition at line 966 of file CallableStatement.java.

00968   {
00969     throw new NotImplementedException("setTimestamp");
00970   }

void org.objectweb.cjdbc.driver.CallableStatement.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.

Parameters:
parameterName the name of the parameter
val the parameter value
Exceptions:
SQLException if a database access error occurs, or if a URL is malformed
See also:
getURL(String)
Since:
1.4

Definition at line 738 of file CallableStatement.java.

00739   {
00740     throw new NotImplementedException("setURL");
00741   }

boolean org.objectweb.cjdbc.driver.CallableStatement.wasNull (   )  throws SQLException
 

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

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

Definition at line 164 of file CallableStatement.java.

00165   {
00166     throw new NotImplementedException("wasNull");
00167   }

The documentation for this class was generated from the following file:
Generated on Mon Apr 11 22:04:52 2005 for C-JDBC by  doxygen 1.3.9.1