|
Oracle Fusion Middleware Java API Reference for Oracle Real-Time Decisions 11g Release 1 (11.1.1) E17787-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StoredProcedure
Interface that provides the functionality to call stored procedures.
Field Summary | |
---|---|
static int |
NO_MORE_RESULTS |
static int |
RESULT_SET_RESULT |
static int |
UPDATE_COUNT_RESULT |
Method Summary | |
---|---|
int |
execute() executes a stored procedure. |
SDResultSet |
executeWithResultSet() executes a stored procedure and returns the result set. |
int |
executeWithUpdateCount() executes a stored procedure that returns an update count. |
java.io.InputStream |
getBinaryStream(int paramIndex) Returns the value of a stored procedure parameter. |
CommitType |
getCommit() returns commit status of stored procedure. |
long |
getDate(int paramIndex) Returns the value of a stored procedure parameter. |
long |
getDate(int paramIndex, java.util.Calendar cal) |
double |
getDouble(int paramIndex) Returns the value of a stored procedure parameter. |
int |
getInt(int paramIndex) Returns the value of a stored procedure parameter. |
long |
getLong(int paramIndex) Returns the value of a stored procedure parameter. |
int |
getMoreResults() returns an indication of whether there are more results from the stored procedure and whether the next result is a result set or an update count. |
SDResultSet |
getResultSet() gets a result set returned from a stored procedure. |
java.lang.String |
getString(int paramIndex) Returns the value of a stored procedure parameter. |
int |
getUpdateCount() gets an update count returned from a stored procedure. |
void |
set(int paramIndex, byte[] value) Deprecated. |
void |
set(int paramIndex, double value) sets a stored procedure parameter with a double value. |
void |
set(int paramIndex, java.io.InputStream value, int length) sets a stored procedure parameter with a InputStream value. |
void |
set(int paramIndex, int value) sets a stored procedure parameter with a int value. |
void |
set(int paramIndex, long value) sets a stored procedure parameter with a long value. |
void |
set(int paramIndex, java.lang.String value) sets a stored procedure parameter with a String value. |
void |
setCommit(CommitType commit) set commit status of stored procedure. |
void |
setDate(int paramIndex, long value) sets a stored procedure parameter with a long value. |
void |
setDate(int paramIndex, long value, java.util.Calendar cal) sets a stored procedure parameter with a long value. |
void |
setNull(int paramIndex) |
boolean |
wasNull() Retrieves whether the last OUT parameter read had the value of SQL NULL . |
Methods inherited from interface com.sigmadynamics.server.DataServices.DatabaseProvider.WriteOnlyStoredProcedure |
---|
close, flush, getName, getParameterCount |
Field Detail |
---|
static final int NO_MORE_RESULTS
static final int RESULT_SET_RESULT
static final int UPDATE_COUNT_RESULT
Method Detail |
---|
void set(int paramIndex, java.lang.String value)
The parameter set is at the ordinal position specified by the paramIndex
parameter. The parameter must be either an IN or INOUT parameter.
set
in interface WriteOnlyStoredProcedure
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.value
- the value for the parametervoid set(int paramIndex, double value)
double
value.
The parameter set is at the ordinal position specified by the paramIndex
parameter. The parameter must be either an IN or INOUT parameter.
set
in interface WriteOnlyStoredProcedure
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.value
- the value for the parametervoid set(int paramIndex, int value)
int
value.
The parameter set is at the ordinal position specified by the paramIndex
parameter. The parameter must be either an IN or INOUT parameter.
set
in interface WriteOnlyStoredProcedure
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.value
- the value for the parametervoid set(int paramIndex, long value)
long
value.
The parameter set is at the ordinal position specified by the paramIndex
parameter. The parameter must be either an IN or INOUT parameter.
set
in interface WriteOnlyStoredProcedure
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.value
- the value for the parametervoid setDate(int paramIndex, long value, java.util.Calendar cal)
long
value.
The parameter set is at the ordinal position specified by the paramIndex
parameter. The parameter must be either an IN or INOUT parameter.
NB. This call will work on TIMESTAMP columns and will also work for DATE or TIME columns but you may need to obey JDBC rules about the date or time values derived from the long in order to avoid problems with drivers.
setDate
in interface WriteOnlyStoredProcedure
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.value
- the value for the parametercal
- a Calendar with which to specify timezonevoid setDate(int paramIndex, long value)
long
value.
The parameter set is at the ordinal position specified by the paramIndex
parameter. The parameter must be either an IN or INOUT parameter.
NB. This call will work on TIMESTAMP columns and will also work for DATE or TIME columns but you may need to obey JDBC rules about the date or time values derived from the long in order to avoid problems with drivers.
setDate
in interface WriteOnlyStoredProcedure
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.value
- the value for the parametervoid set(int paramIndex, java.io.InputStream value, int length)
InputStream
value.
The parameter set is at the ordinal position specified by the paramIndex
parameter. The parameter must be either an IN or INOUT parameter.
set
in interface WriteOnlyStoredProcedure
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.value
- the value for the parameter
@Deprecated
void set(int paramIndex,
byte[] value)
byte[]
.
The parameter set is at the ordinal position specified by the paramIndex
parameter. The parameter must be either an IN or INOUT parameter.
set
in interface WriteOnlyStoredProcedure
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.value
- the value for the parametervoid setNull(int paramIndex)
setNull
in interface WriteOnlyStoredProcedure
java.lang.String getString(int paramIndex)
Returns the value of the parameter specified by the paramIndex
parameter. The parameter must be either an OUT or INOUT parameter.
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.double getDouble(int paramIndex)
Returns the value of the parameter specified by the paramIndex
parameter. The parameter must be either an OUT or INOUT parameter.
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.long getLong(int paramIndex)
Returns the value of the parameter specified by the paramIndex
parameter. The parameter must be either an OUT or INOUT parameter.
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.long getDate(int paramIndex)
Returns the value of the parameter specified by the paramIndex
parameter. The parameter must be either an OUT or INOUT parameter.
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.long getDate(int paramIndex, java.util.Calendar cal)
int getInt(int paramIndex)
Returns the value of the parameter specified by the paramIndex
parameter. The parameter must be either an OUT or INOUT parameter.
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.java.io.InputStream getBinaryStream(int paramIndex)
Returns the value of the parameter specified by the paramIndex
parameter. The parameter must be either an OUT or INOUT parameter.
paramIndex
- specifies which parameter. The first parameter is 1, the second is 2, etc.boolean wasNull()
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.true
if the last parameter read was SQL NULL
; false
otherwiseDatabaseProviderException
- if a database access error occursSDResultSet executeWithResultSet()
Executes a stored procedure that is known to return a result set. You must set all IN or INOUT parameters using the set
methods before calling this method.
int executeWithUpdateCount()
Executes a stored procedure that is known to return an update count. You must set all IN or INOUT parameters using the set
methods before calling this method.
int execute()
Call this method to execute a stored procedure when you don't know whether the stored procedure returns a result set or an update count. It returns either RESULT_SET_RESULT
to indicate a result set or UPDATE_COUNT_RESULT
to indicate an update count.
You must set all IN and INOUT parameters using the set
methods before calling this method.
execute
in interface WriteOnlyStoredProcedure
RESULT_SET_RESULT
to indicate a result set or UPDATE_COUNT_RESULT
to indicate an update countint getUpdateCount()
Call this method after a call to getMoreResults
indicates that an update count is the next result.
SDResultSet getResultSet()
Call this method after a call to getMoreResults
indicates that a result set is the next result.
int getMoreResults()
NO_MORE_RESULTS
to indicate that there are no more results; RESULT_SET_RESULT
to indicate that the next result is a result set; or UPDATE_COUNT_RESULT
to indicate the next result is an update count.CommitType getCommit()
void setCommit(CommitType commit)
|
Oracle Fusion Middleware Java API Reference for Oracle Real-Time Decisions 11g Release 1 (11.1.1) E17787-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |