vortex.sql
Class vortexCallableStatement

java.lang.Object
  vortex.sql.vortexStatement
      vortex.sql.vortexPreparedStatement
          vortex.sql.vortexCallableStatement

All Implemented Interfaces:

java.sql.CallableStatement, java.sql.PreparedStatement, java.sql.Statement

public class vortexCallableStatement
extends vortexPreparedStatement
implements java.sql.CallableStatement

The interface used to execute SQL stored procedures.

JDBC provides a stored procedure SQL escape that allows stored procedures to be called in a standard way for all RDBMS's. This escape syntax has one form that includes a result parameter and one that does not. If used, the result parameter must be registered as an OUT parameter. The other parameters may be used for input, output or both. Parameters are refered to sequentially, by number. The first parameter is 1.

{?= call [,, ...]}
{call [,, ...]}

IN parameter values are set using the set methods inherited from PreparedStatement. The type of all OUT parameters must be registered prior to executing the stored procedure; their values are retrieved after execution via the get methods provided here.

A Callable statement may return a ResultSet or multiple ResultSets. Multiple ResultSets are handled using operations inherited from Statement.

See Also:

Connection.prepareCall(java.lang.String), ResultSet

Field Summary

Fields inherited from class vortex.sql.vortexPreparedStatement

npa

Fields inherited from class vortex.sql.vortexStatement

cName, conn, lcur, ldb, record, result

Fields inherited from interface java.sql.Statement

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

Constructor Summary

vortexCallableStatement(java.sql.Connection c, dbChannel db, java.lang.String sql)

Method Summary

int	executeUpdate() Execute a stored procedure.
java.sql.Array	getArray(int i) JDBC 2.0 Gets the value of a JDBC ARRAY parameter as an Array object in the Java programming language.
java.sql.Array	getArray(java.lang.String parameterName) Retrieves the value of a JDBC ARRAY parameter as an Array object in the Java programming language.
java.math.BigDecimal	getBigDecimal(int column) JDBC 2.0 Gets 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.math.BigDecimal	getBigDecimal(int column, int scale) Get the value of a NUMERIC parameter as a java.sql.Numeric object.
java.math.BigDecimal	getBigDecimal(java.lang.String parameterName) 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.sql.Blob	getBlob(int i) JDBC 2.0 Gets the value of a JDBC BLOB parameter as a Blob object in the Java programming language.
java.sql.Blob	getBlob(java.lang.String parameterName) Retrieves the value of a JDBC BLOB parameter as a Blob object in the Java programming language.
boolean	getBoolean(int column) Get the value of a BIT parameter as a Java boolean.
boolean	getBoolean(java.lang.String parameterName) Retrieves the value of a JDBC BIT parameter as a boolean in the Java programming language.
byte	getByte(int column) Get the value of a TINYINT parameter as a Java byte.
byte	getByte(java.lang.String parameterName) Retrieves the value of a JDBC TINYINT parameter as a byte in the Java programming language.
byte[]	getBytes(int column) Get the value of a SQL BINARY or VARBINARY parameter as a Java byte[]
byte[]	getBytes(java.lang.String parameterName) Retrieves the value of a JDBC BINARY or VARBINARY parameter as an array of byte values in the Java programming language.
java.sql.Clob	getClob(int i) JDBC 2.0 Gets the value of a JDBC CLOB parameter as a Clob object in the Java programming language.
java.sql.Clob	getClob(java.lang.String parameterName) Retrieves the value of a JDBC CLOB parameter as a Clob object in the Java programming language.
java.sql.Date	getDate(int column) Get the value of a SQL DATE parameter as a java.sql.Date object
java.sql.Date	getDate(int parameterIndex, java.util.Calendar cal) Gets the value of a JDBC DATE parameter as a java.sql.Date object, using the given Calendar object to construct the date.
java.sql.Date	getDate(java.lang.String parameterName) 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) 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 column) Get the value of a DOUBLE parameter as a Java double.
double	getDouble(java.lang.String parameterName) Retrieves the value of a JDBC DOUBLE parameter as a double in the Java programming language.
float	getFloat(int column) Get the value of a FLOAT parameter as a Java float.
float	getFloat(java.lang.String parameterName) Retrieves the value of a JDBC FLOAT parameter as a float in the Java programming language.
int	getInt(int column) Get the value of a INTEGER parameter as a Java int.
int	getInt(java.lang.String parameterName) Retrieves the value of a JDBC INTEGER parameter as an int in the Java programming language.
long	getLong(int column) Get the value of a BIGINT parameter as a Java long.
long	getLong(java.lang.String parameterName) Retrieves the value of a JDBC BIGINT parameter as a long in the Java programming language.
java.lang.Object	getObject(int i) Get the value of a parameter as a Java object.
java.lang.Object	getObject(int i, java.util.Map map) JDBC 2.0 Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.
java.lang.Object	getObject(java.lang.String parameterName) 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) Returns an object representing the value of OUT parameter i and uses map for the custom mapping of the parameter value.
java.sql.Ref	getRef(int i) JDBC 2.0 Gets the value of a JDBC REF() parameter as a Ref object in the Java programming language.
java.sql.Ref	getRef(java.lang.String parameterName) Retrieves the value of a JDBC REF() parameter as a Ref object in the Java programming language.
short	getShort(int column) Get the value of a SMALLINT parameter as a Java short.
short	getShort(java.lang.String parameterName) Retrieves the value of a JDBC SMALLINT parameter as a short in the Java programming language.
java.lang.String	getString(int column) Get the value of a CHAR, VARCHAR, or LONGVARCHAR parameter as a Java String.
java.lang.String	getString(java.lang.String parameterName) Retrieves the value of a JDBC CHAR, VARCHAR, or LONGVARCHAR parameter as a String in the Java programming language.
java.sql.Time	getTime(int column) Get the value of a SQL TIME parameter as a java.sql.Time object.
java.sql.Time	getTime(int parameterIndex, java.util.Calendar cal) Gets the value of a JDBC TIME parameter as a java.sql.Time object, using the given Calendar object to construct the time.
java.sql.Time	getTime(java.lang.String parameterName) 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) 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 column) Get the value of a SQL TIMESTAMP parameter as a java.sql.Timestamp object.
java.sql.Timestamp	getTimestamp(int parameterIndex, java.util.Calendar cal) Gets the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
java.sql.Timestamp	getTimestamp(java.lang.String parameterName) 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) Retrieves the value of a JDBC TIMESTAMP parameter as a java.sql.Timestamp object, using the given Calendar object to construct the Timestamp object.
java.net.URL	getURL(int parameterIndex) Retrieves the value of the designated JDBC DATALINK parameter as a java.net.URL object.
java.net.URL	getURL(java.lang.String parameterName) Retrieves the value of a JDBC DATALINK parameter as a java.net.URL object.
void	registerOutParameter(int column, int sqlType) Before executing a stored procedure call you must explicitly call registerOutParameter to register the java.sql.Type of each out parameter.
void	registerOutParameter(int column, int sqlType, int scale) Use this version of registerOutParameter for registering Numeric or Decimal out parameters.
void	registerOutParameter(int parameterIndex, int sqlType, java.lang.String typeName) JDBC 2.0 Registers the designated output parameter.
void	registerOutParameter(java.lang.String parameterName, int sqlType) Registers the OUT parameter named parameterName to the JDBC type sqlType.
void	registerOutParameter(java.lang.String parameterName, int sqlType, int scale) Registers the parameter named parameterName to be of JDBC type sqlType.
void	registerOutParameter(java.lang.String parameterName, int sqlType, java.lang.String typeName) Registers the designated output parameter.
void	setAsciiStream(java.lang.String parameterName, java.io.InputStream x, int length) 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) Set a parameter to a java.sql.Numeric value.
void	setBinaryStream(java.lang.String parameterName, java.io.InputStream x, int length) 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) Sets the designated parameter to the given Java boolean value.
void	setByte(java.lang.String parameterName, byte x) Sets the designated parameter to the given Java byte value.
void	setBytes(java.lang.String parameterName, byte[] x) Set a parameter to a Java array of bytes.
void	setCharacterStream(java.lang.String parameterName, java.io.Reader reader, int length) 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) Set a parameter to a java.sql.Date value.
void	setDate(java.lang.String parameterName, java.sql.Date x, java.util.Calendar cal) Sets the designated parameter to the given java.sql.Date value, using the given Calendar object.
void	setDouble(java.lang.String parameterName, double x) Set a parameter to a Java double value.
void	setFloat(java.lang.String parameterName, float x) Set a parameter to a Java float value.
void	setInt(java.lang.String parameterName, int x) Set a parameter to a Java int value.
void	setLong(java.lang.String parameterName, long x) Set a parameter to a Java long value.
void	setNull(java.lang.String parameterName, int sqlType) Sets the designated parameter to SQL NULL.
void	setNull(java.lang.String parameterName, int sqlType, java.lang.String typeName) Sets the designated parameter to SQL NULL.
void	setObject(java.lang.String parameterName, java.lang.Object x) Sets the value of the designated parameter with the given object.
void	setObject(java.lang.String parameterName, java.lang.Object x, int targetSqlType) 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) Sets the value of the designated parameter with the given object.
void	setShort(java.lang.String parameterName, short x) Set a parameter to a Java short value.
void	setString(java.lang.String parameterName, java.lang.String x) Set a parameter to a Java String value.
void	setTime(java.lang.String parameterName, java.sql.Time x) Set a parameter to a java.sql.Time value.
void	setTime(java.lang.String parameterName, java.sql.Time x, java.util.Calendar cal) 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) Set a parameter to a java.sql.Timestamp value.
void	setTimestamp(java.lang.String parameterName, java.sql.Timestamp x, java.util.Calendar cal) 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) Sets the designated parameter to the given java.net.URL object.
boolean	wasNull() An OUT parameter may have the value of SQL NULL; wasNull reports whether the last value read has this special value.

Methods inherited from class vortex.sql.vortexPreparedStatement

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

Methods inherited from class vortex.sql.vortexStatement

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

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.sql.PreparedStatement

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

Methods inherited from interface java.sql.Statement

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

Constructor Detail

vortexCallableStatement

public vortexCallableStatement(java.sql.Connection c,
                               dbChannel db,
                               java.lang.String sql)
                        throws java.sql.SQLException

Throws:

java.sql.SQLException

Method Detail

registerOutParameter

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

Before executing a stored procedure call you must explicitly call registerOutParameter to register the java.sql.Type of each out parameter.

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.

Specified by:

registerOutParameter in interface java.sql.CallableStatement

Parameters:

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

sqlType - SQL type code defined by java.sql.Types; for parameters of type Numeric or Decimal use the version of registerOutParameter that accepts a scale value

Throws:

java.sql.SQLException - thrown if column out of range

See Also:

Types

registerOutParameter

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

Use this version of registerOutParameter for registering Numeric or Decimal out parameters.

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.

Specified by:

registerOutParameter in interface java.sql.CallableStatement

Parameters:

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

sqlType - use either java.sql.Type.NUMERIC or java.sql.Type.DECIMAL

scale - a value greater than or equal to zero representing the desired number of digits to the right of the decimal point

Throws:

java.sql.SQLException - thrown if column out of range

See Also:

Types

registerOutParameter

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

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

Specified by:

registerOutParameter in interface java.sql.CallableStatement

Parameters:

parameterIndex - - the first parameter is 1, the second is 2,...

sqlType - - a value from Types

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

Throws:

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

wasNull

public boolean wasNull()
                throws java.sql.SQLException

An OUT parameter may have the value of SQL NULL; wasNull reports whether the last value read has this special value.

Note: You must first call getXXX on a parameter to read its value and then call wasNull() to find if the value was SQL NULL.

Specified by:

wasNull in interface java.sql.CallableStatement

Returns:

true if the last parameter read was SQL NULL

Throws:

java.sql.SQLException - Not apply

getString

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

Get the value of a CHAR, VARCHAR, or LONGVARCHAR parameter as a Java String.

Specified by:

getString in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is null

Throws:

java.sql.SQLException - thrown if column out of range

getBoolean

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

Get the value of a BIT parameter as a Java boolean.

Specified by:

getBoolean in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is false

Throws:

java.sql.SQLException - thrown if column out of range

getByte

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

Get the value of a TINYINT parameter as a Java byte.

Specified by:

getByte in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is 0

Throws:

java.sql.SQLException - thrown if column out of range

getShort

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

Get the value of a SMALLINT parameter as a Java short.

Specified by:

getShort in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is 0

Throws:

java.sql.SQLException - thrown if column out of range

getInt

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

Get the value of a INTEGER parameter as a Java int.

Specified by:

getInt in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is 0

Throws:

java.sql.SQLException - thrown if column out of range

getLong

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

Get the value of a BIGINT parameter as a Java long.

Specified by:

getLong in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is 0

Throws:

java.sql.SQLException - thrown if column out of range

getFloat

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

Get the value of a FLOAT parameter as a Java float.

Specified by:

getFloat in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is 0

Throws:

java.sql.SQLException - thrown if column out of range

getDouble

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

Get the value of a DOUBLE parameter as a Java double.

Specified by:

getDouble in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is 0

Throws:

java.sql.SQLException - thrown if column out of range

getBigDecimal

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

Get the value of a NUMERIC parameter as a java.sql.Numeric object.

Specified by:

getBigDecimal in interface java.sql.CallableStatement

Parameters:

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

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

Throws:

java.sql.SQLException - thrown if column out of range

getBigDecimal

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

JDBC 2.0 Gets 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.

Specified by:

getBigDecimal in interface java.sql.CallableStatement

Parameters:

column - 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.

Throws:

java.sql.SQLException - thrown if column out of range

getBytes

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

Get the value of a SQL BINARY or VARBINARY parameter as a Java byte[]

Specified by:

getBytes in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is null

Throws:

java.sql.SQLException - thrown if column out of range

getDate

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

Get the value of a SQL DATE parameter as a java.sql.Date object

Specified by:

getDate in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is null

Throws:

java.sql.SQLException - thrown if column out of range

getDate

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

Gets 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.

Specified by:

getDate in interface java.sql.CallableStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

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

getTime

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

Get the value of a SQL TIME parameter as a java.sql.Time object.

Specified by:

getTime in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is null

Throws:

java.sql.SQLException - thrown if column out of range

getTime

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

Gets 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.

Specified by:

getTime in interface java.sql.CallableStatement

Parameters:

parameterIndex - the first parameter is 1, the second is 2, ...

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

getTimestamp

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

Get the value of a SQL TIMESTAMP parameter as a java.sql.Timestamp object.

Specified by:

getTimestamp in interface java.sql.CallableStatement

Parameters:

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

Returns:

the parameter value; if the value is SQL NULL the result is null

Throws:

java.sql.SQLException - thrown if column out of range

getTimestamp

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

Gets 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.

Specified by:

getTimestamp in interface java.sql.CallableStatement

Parameters:

parameterIndex - - the first parameter is 1, the second is 2, ...

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

getObject

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

Get the value of a parameter as a Java object.

This method returns a Java object whose type coresponds to the SQL type that was registered for this parameter using registerOutParameter.

Note that this method may be used to read datatabase specific abstract data types, by specifying a targetSqlType of java.sql.types.OTHER which allows the driver to return a database specific Java type.

Specified by:

getObject in interface java.sql.CallableStatement

Parameters:

i - The first parameter is 1, the second is 2, ...

Returns:

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

Throws:

java.sql.SQLException - thrown if column out of range

See Also:

Types

getObject

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

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

Specified by:

getObject in interface java.sql.CallableStatement

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.

Throws:

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

getBlob

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

JDBC 2.0 Gets the value of a JDBC BLOB parameter as a Blob object in the Java programming language.

Specified by:

getBlob in interface java.sql.CallableStatement

Parameters:

i - the first parameter is 1, the second is 2, and so on

Returns:

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

Throws:

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

getArray

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

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

Specified by:

getArray in interface java.sql.CallableStatement

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.

Throws:

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

getClob

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

JDBC 2.0 Gets the value of a JDBC CLOB parameter as a Clob object in the Java programming language.

Specified by:

getClob in interface java.sql.CallableStatement

Parameters:

i - the first parameter is 1, the second is 2, and so on

Returns:

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

Throws:

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

getRef

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

JDBC 2.0 Gets the value of a JDBC REF() parameter as a Ref object in the Java programming language.

Specified by:

getRef in interface java.sql.CallableStatement

Parameters:

i - - the first parameter is 1, the second is 2, ...

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

executeUpdate

public int executeUpdate()
                  throws java.sql.SQLException

Execute a stored procedure.

Specified by:

executeUpdate in interface java.sql.PreparedStatement

Overrides:

executeUpdate in class vortexPreparedStatement

Returns:

either the row count for INSERT, UPDATE or DELETE; or 0 for SQL statements that return nothing

Throws:

java.sql.SQLException - thrown if DB actions fail.

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType)
                          throws java.sql.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(int) retrieves the value.

Specified by:

registerOutParameter in interface java.sql.CallableStatement

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

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType,
                                 int scale)
                          throws java.sql.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.

Specified by:

registerOutParameter in interface java.sql.CallableStatement

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

registerOutParameter

public void registerOutParameter(java.lang.String parameterName,
                                 int sqlType,
                                 java.lang.String typeName)
                          throws java.sql.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.

Specified by:

registerOutParameter in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

sqlType - - a value from Types

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

Throws:

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

getURL

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

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

Specified by:

getURL in interface java.sql.CallableStatement

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

setURL

public void setURL(java.lang.String parameterName,
                   java.net.URL val)
            throws java.sql.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.

Specified by:

setURL in interface java.sql.CallableStatement

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

setNull

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

Sets the designated parameter to SQL NULL. Note: You must specify the parameter's SQL type.

Specified by:

setNull in interface java.sql.CallableStatement

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

setBoolean

public void setBoolean(java.lang.String parameterName,
                       boolean x)
                throws java.sql.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.

Specified by:

setBoolean in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - - the parameter value

Throws:

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

setByte

public void setByte(java.lang.String parameterName,
                    byte x)
             throws java.sql.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.

Specified by:

setByte in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - - the parameter value

Throws:

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

setShort

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

Set a parameter to a Java short value. The driver converts this to a SQL SMALLINT value when it sends it to the database.

Specified by:

setShort in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setInt

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

Set a parameter to a Java int value. The driver converts this to a SQL INTEGER value when it sends it to the database.

Specified by:

setInt in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setLong

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

Set a parameter to a Java long value. The driver converts this to a SQL BIGINT value when it sends it to the database.

Specified by:

setLong in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setFloat

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

Set a parameter to a Java float value. The driver converts this to a SQL FLOAT value when it sends it to the database.

Specified by:

setFloat in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setDouble

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

Set a parameter to a Java double value. The driver converts this to a SQL DOUBLE value when it sends it to the database.

Specified by:

setDouble in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setBigDecimal

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

Set a parameter to a java.sql.Numeric value. VORTEXjdbc converts this to a character string value when it sends it to the database.

Specified by:

setBigDecimal in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setString

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

Set a parameter to a Java String value. The driver converts this to a SQL VARCHAR or LONGVARCHAR value (depending on the arguments size relative to the driver's limits on VARCHARs) when it sends it to the database.

Specified by:

setString in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setBytes

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

Set a parameter to a Java array of bytes. The driver converts this to a SQL VARBINARY or LONGVARBINARY (depending on the arguments size relative to the driver's limits on VARBINARYs) when it sends

Specified by:

setBytes in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setDate

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

Set a parameter to a java.sql.Date value. The driver converts this to a SQL DATE value when it sends it to the database.

Specified by:

setDate in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setTime

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

Set a parameter to a java.sql.Time value. The driver converts this to a SQL TIME value when it sends it to the database.

Specified by:

setTime in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setTimestamp

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

Set a parameter to a java.sql.Timestamp value. The driver converts this to a SQL VARCHAR value when it sends it to the database.

Specified by:

setTimestamp in interface java.sql.CallableStatement

Parameters:

parameterName - - the name of the parameter

x - the parameter value

Throws:

java.sql.SQLException - thrown if column out of range or unable to bind parameter

setAsciiStream

public void setAsciiStream(java.lang.String parameterName,
                           java.io.InputStream x,
                           int length)
                    throws java.sql.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.

Specified by:

setAsciiStream in interface java.sql.CallableStatement

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

setBinaryStream

public void setBinaryStream(java.lang.String parameterName,
                            java.io.InputStream x,
                            int length)
                     throws java.sql.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.

Specified by:

setBinaryStream in interface java.sql.CallableStatement

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

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x,
                      int targetSqlType,
                      int scale)
               throws java.sql.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.

Specified by:

setObject in interface java.sql.CallableStatement

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:

- - if a database access error occurs

java.sql.SQLException

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x,
                      int targetSqlType)
               throws java.sql.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.

Specified by:

setObject in interface java.sql.CallableStatement

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

setObject

public void setObject(java.lang.String parameterName,
                      java.lang.Object x)
               throws java.sql.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.

Specified by:

setObject in interface java.sql.CallableStatement

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

setCharacterStream

public void setCharacterStream(java.lang.String parameterName,
                               java.io.Reader reader,
                               int length)
                        throws java.sql.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.

Specified by:

setCharacterStream in interface java.sql.CallableStatement

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

setDate

public void setDate(java.lang.String parameterName,
                    java.sql.Date x,
                    java.util.Calendar cal)
             throws java.sql.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.

Specified by:

setDate in interface java.sql.CallableStatement

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

setTime

public void setTime(java.lang.String parameterName,
                    java.sql.Time x,
                    java.util.Calendar cal)
             throws java.sql.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.

Specified by:

setTime in interface java.sql.CallableStatement

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

setTimestamp

public void setTimestamp(java.lang.String parameterName,
                         java.sql.Timestamp x,
                         java.util.Calendar cal)
                  throws java.sql.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:

Specified by:

setTimestamp in interface java.sql.CallableStatement

Parameters:

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

setNull

public void setNull(java.lang.String parameterName,
                    int sqlType,
                    java.lang.String typeName)
             throws java.sql.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.

Specified by:

setNull in interface java.sql.CallableStatement

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

Throws:

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

getString

public java.lang.String getString(java.lang.String parameterName)
                           throws java.sql.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.

Specified by:

getString in interface java.sql.CallableStatement

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

getBoolean

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

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

Specified by:

getBoolean in interface java.sql.CallableStatement

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

getByte

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

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

Specified by:

getByte in interface java.sql.CallableStatement

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

getShort

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

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

Specified by:

getShort in interface java.sql.CallableStatement

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

getInt

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

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

Specified by:

getInt in interface java.sql.CallableStatement

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

getLong

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

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

Specified by:

getLong in interface java.sql.CallableStatement

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

getFloat

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

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

Specified by:

getFloat in interface java.sql.CallableStatement

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

getDouble

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

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

Specified by:

getDouble in interface java.sql.CallableStatement

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

getBytes

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

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

Specified by:

getBytes in interface java.sql.CallableStatement

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

getDate

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

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

Specified by:

getDate in interface java.sql.CallableStatement

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

getTime

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

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

Specified by:

getTime in interface java.sql.CallableStatement

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

getTimestamp

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

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

Specified by:

getTimestamp in interface java.sql.CallableStatement

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

getObject

public java.lang.Object getObject(java.lang.String parameterName)
                           throws java.sql.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.

Specified by:

getObject in interface java.sql.CallableStatement

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

getBigDecimal

public java.math.BigDecimal getBigDecimal(java.lang.String parameterName)
                                   throws java.sql.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.

Specified by:

getBigDecimal in interface java.sql.CallableStatement

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

getObject

public java.lang.Object getObject(java.lang.String parameterName,
                                  java.util.Map map)
                           throws java.sql.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.

Specified by:

getObject in interface java.sql.CallableStatement

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

Throws:

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

getRef

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

Retrieves the value of a JDBC REF() parameter as a Ref object in the Java programming language.

Specified by:

getRef in interface java.sql.CallableStatement

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

getBlob

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

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

Specified by:

getBlob in interface java.sql.CallableStatement

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

getClob

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

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

Specified by:

getClob in interface java.sql.CallableStatement

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

getArray

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

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

Specified by:

getArray in interface java.sql.CallableStatement

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

getDate

public java.sql.Date getDate(java.lang.String parameterName,
                             java.util.Calendar cal)
                      throws java.sql.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.

Specified by:

getDate in interface java.sql.CallableStatement

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

getTime

public java.sql.Time getTime(java.lang.String parameterName,
                             java.util.Calendar cal)
                      throws java.sql.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.

Specified by:

getTime in interface java.sql.CallableStatement

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

getTimestamp

public java.sql.Timestamp getTimestamp(java.lang.String parameterName,
                                       java.util.Calendar cal)
                                throws java.sql.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.

Specified by:

getTimestamp in interface java.sql.CallableStatement

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

getURL

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

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

Specified by:

getURL in interface java.sql.CallableStatement

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