oracle.jdbc
Interface OracleCallableStatement

public abstract interface OracleCallableStatement

extends java.sql.CallableStatement, OraclePreparedStatement

Since:

8.1.7

Fields inherited from class oracle.jdbc.OraclePreparedStatement

FORM_CHAR, FORM_NCHAR

Fields inherited from class oracle.jdbc.OracleStatement

EXPLICIT, IMPLICIT, NEW

Method Summary

ARRAY	getARRAY(int parameterIndex)
java.io.InputStream	getAsciiStream(int parameterIndex)
BFILE	getBFILE(int parameterIndex)
java.io.InputStream	getBinaryStream(int parameterIndex)
BLOB	getBLOB(int parameterIndex)
CHAR	getCHAR(int parameterIndex)
CLOB	getCLOB(int parameterIndex)
java.sql.ResultSet	getCursor(int parameterIndex)
java.lang.Object	getCustomDatum(int parameterIndex, CustomDatumFactory factory) Deprecated.
DATE	getDATE(int parameterIndex)
NUMBER	getNUMBER(int parameterIndex)
OPAQUE	getOPAQUE(int parameterIndex)
Datum	getOracleObject(int parameterIndex)
Datum[]	getOraclePlsqlIndexTable(int paramIndex) Oracle OCI driver specific.
java.lang.Object	getORAData(int parameterIndex, ORADataFactory factory)
java.lang.Object	getPlsqlIndexTable(int paramIndex) Oracle OCI driver specific.
java.lang.Object	getPlsqlIndexTable(int paramIndex, java.lang.Class primitiveType) Oracle OCI driver specific.
RAW	getRAW(int parameterIndex)
REF	getREF(int parameterIndex)
ROWID	getROWID(int parameterIndex)
STRUCT	getSTRUCT(int parameterIndex)
TIMESTAMP	getTIMESTAMP(int paramIdx) Obtains an ouput oracle.sql.TIMESTAMP value.
TIMESTAMPLTZ	getTIMESTAMPLTZ(int paramIdx) Obtains an ouput oracle.sql.TIMESTAMPLTZ value.
TIMESTAMPTZ	getTIMESTAMPTZ(int paramIdx) Obtains an ouput oracle.sql.TIMESTAMPTZ value.
java.io.InputStream	getUnicodeStream(int parameterIndex)
void	registerIndexTableOutParameter(int paramIndex, int maxLen, int elemSqlType, int elemMaxLen) Oracle OCI driver specific.
void	registerOutParameter(int paramIndex, int sqlType, int scale, int maxLength) Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns.
int	sendBatch() Send the sets of parameters batched (for Oracle-style batching only).
void	setExecuteBatch(int nrows) Set the batch value (for Oracle-style batching only).

Methods inherited from interface java.sql.CallableStatement

getArray, getBigDecimal, getBigDecimal, getBlob, getBoolean, getByte, getBytes, getClob, getDate, getDate, getDouble, getFloat, getInt, getLong, getObject, getObject, getRef, getShort, getString, getTime, getTime, getTimestamp, getTimestamp, registerOutParameter, registerOutParameter, registerOutParameter, wasNull

Methods inherited from interface oracle.jdbc.OraclePreparedStatement

defineParameterType, getExecuteBatch, setARRAY, setBfile, setBFILE, setBLOB, setCHAR, setCheckBindTypes, setCLOB, setCursor, setCustomDatum, setDATE, setDisableStmtCaching, setFixedCHAR, setFormOfUse, setNUMBER, setOPAQUE, setOracleObject, setORAData, setPlsqlIndexTable, setRAW, setREF, setRefType, setROWID, setSTRUCT, setStructDescriptor, setTIMESTAMP, setTIMESTAMPLTZ, setTIMESTAMPTZ

Methods inherited from interface oracle.jdbc.OracleStatement

clearDefines, closeWithKey, creationState, defineColumnType, defineColumnType, defineColumnType, defineColumnTypeChars, getRowPrefetch, setResultSetCache, setRowPrefetch

Method Detail

getARRAY

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getAsciiStream

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getBFILE

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getBinaryStream

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getBLOB

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getCHAR

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getCLOB

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getCursor

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getCustomDatum

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

Deprecated.

Parameters:

parameterIndex -

factory -

Returns:

getORAData

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

Parameters:

parameterIndex -

factory -

Returns:

getDATE

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getNUMBER

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getOPAQUE

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getOracleObject

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getRAW

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getREF

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getROWID

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getSTRUCT

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

getTIMESTAMP

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

Obtains an ouput oracle.sql.TIMESTAMP value.

Parameters:

paramIdx - parameter index.

Returns:

the obtained TIMESTAMP object.

Throws:

java.sql.SQLException - if an error occurred.

Since:

9i

getTIMESTAMPTZ

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

Obtains an ouput oracle.sql.TIMESTAMPTZ value.

Parameters:

paramIdx - parameter index.

Returns:

the obtained TIMESTAMPTZ object.

Throws:

java.sql.SQLException - if an error occurred.

Since:

9i

getTIMESTAMPLTZ

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

Obtains an ouput oracle.sql.TIMESTAMPLTZ value.

Parameters:

paramIdx - parameter index.

Returns:

the obtained TIMESTAMPLTZ object.

Throws:

java.sql.SQLException - if an error occurred.

Since:

9i

getUnicodeStream

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

Parameters:

parameterIndex -

Returns:

Throws:

java.sql.SQLException -

registerOutParameter

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

Special Oracle version of registerOutParameter for registering CHAR, VARCHAR, LONG, RAW and LONG RAW columns.

Parameters:

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

sqlType - type of the bind parameter

scale - not used

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

sendBatch

public int sendBatch()
              throws java.sql.SQLException

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

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

Specified by:

sendBatch in interface OraclePreparedStatement

setExecuteBatch

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

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

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

Specified by:

setExecuteBatch in interface OraclePreparedStatement

getPlsqlIndexTable

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

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

Parameters:

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

Returns:

A java.lang.Object holding the parameter value.

Throws:

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

getPlsqlIndexTable

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

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

Parameters:

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

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

Returns:

A java.lang.Object holding the parameter value.

Throws:

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

getOraclePlsqlIndexTable

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

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

Parameters:

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

Returns:

A Datum array holding the parameter value.

Throws:

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

registerIndexTableOutParameter

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

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

Parameters:

paramIndex - parameter index.

maxLen - the maximum possible number of elements.

curLen - the current number of elements

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

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

Throws:

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

Since:

8.1.7