Interface StoredProcedurePlan
public interface StoredProcedurePlan
This interface defines the methods used to obtain information about the
execution of a stored procedure.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
The stored procedure execution threw an errorstatic final int
The stored procedure execution has not started yetstatic final int
The stored procedure execution has finished successfullystatic final int
The stored procedure execution is being executed at this timestatic final int
The stored procedure execution has been stopped -
Method Summary
Modifier and TypeMethodDescriptionObtains the time when the procedure finished its execution.Obtains the exception associated with the error occurred in the execution.int
Obtains the number of tuples returned by the procedure.Obtains the time when the procedure generated its first row of results.Obtains the time when the procedure started its execution.int
getState()
Obtains the state of the procedure execution.boolean
Returns whether the procedure finished successfully its execution or not.
-
Field Details
-
OK
static final int OKThe stored procedure execution has finished successfully- See Also:
-
ERROR
static final int ERRORThe stored procedure execution threw an error- See Also:
-
INIT
static final int INITThe stored procedure execution has not started yet- See Also:
-
PROCESSING
static final int PROCESSINGThe stored procedure execution is being executed at this time- See Also:
-
STOPPED
static final int STOPPEDThe stored procedure execution has been stopped- See Also:
-
-
Method Details
-
getEndTime
Date getEndTime()Obtains the time when the procedure finished its execution.- Returns:
- the time when the procedure finished its execution.
-
getNumOfTuples
int getNumOfTuples()Obtains the number of tuples returned by the procedure.- Returns:
- the number of tuples returned by the procedure.
-
getResponseTime
Date getResponseTime()Obtains the time when the procedure generated its first row of results.- Returns:
- the time when the procedure generated its first row of results.
-
getStartTime
Date getStartTime()Obtains the time when the procedure started its execution.- Returns:
- the time when the procedure started its execution.
-
getState
int getState()Obtains the state of the procedure execution.- Returns:
- an integer representing the procedure state.
-
getException
Throwable getException()Obtains the exception associated with the error occurred in the execution.- Returns:
- the exception associated with the error occurred in the execution.
-
isComplete
boolean isComplete()Returns whether the procedure finished successfully its execution or not.- Returns:
true
if the procedure finished successfully,false
otherwise.
-