Skip navigation links

oracle.as.scheduler
Interface RequestExecutionContext

All Superinterfaces:

java.io.Serializable

public interface RequestExecutionContext

extends java.io.Serializable

Defines the context of a request execution. An execution context is used by a request executable, pre-process callback, and post-process callback to retrieve information about the context in which the request is running.

See Also:

Executable, PreProcessHandler, PostProcessHandler

Field Summary

static long

serialVersionUID

Method Summary

long	getEnterpriseId() Returns the enterprise ID of the request.
State	getExecStageState() Returns the state of the job execution, which can be either SUCCEEDED or WARNING.
java.lang.String	getPausedState() Gets the paused state specified by the application when this request was previously paused.
java.lang.String	getRequestHandle() Gets the request handle associated with the executing request.
long	getRequestId() Gets the request identifier of the executing request.
boolean	isResumed() Indicates whether this request being resumed from a PAUSED state.
java.lang.String	toIdString() Returns a String representation of this object suitable for use as a web service message ID.
java.lang.String	toString() Returns a String representation of this object suitable for use in a web service call such as setAsyncRequestStatus.

Field Detail

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

Method Detail

getRequestId

long getRequestId()

Gets the request identifier of the executing request.

Returns:

the request ID associated with this context

isResumed

boolean isResumed()

Indicates whether this request being resumed from a PAUSED state. This allows a request executable that submits sub-requests to determine if the executable is being run the first time, or it is being resumed after the sub-requests have completed.

Returns:

true if the request is being resumed, or false of not

getPausedState

java.lang.String getPausedState()

Gets the paused state specified by the application when this request was previously paused. The returned value reflects the paused state retreived from the ExecutionPausedException used to pause the request.

The value returned by this method is meaningful only for a resumed request; that is, when
(isResumed() = true).

Returns:

the paused state associated with this request. This will be null if no paused state was specified, or this context does not represent a resumed request.

See Also:

ExecutionPausedException

getRequestHandle

java.lang.String getRequestHandle()

Gets the request handle associated with the executing request. The request handle represents an opaque identifer for the request.

The request handle is guaranteed to be non-null only when the target request executable is executing; that is, the Java procedure for Java jobs, the PLSQL stored procedure for SQL jobs, and the target executable for process jobs. The request handle may not be available at other times, for example, the pre-process and post-process callback handlers.

Returns:

the request handle, or null if one is not available

getExecStageState

State getExecStageState()

Returns the state of the job execution, which can be either SUCCEEDED or WARNING. This value is available only to the post-processor as it is set in the request execution context after the finalize stage.

Returns:

state of the job execution, or SUCCEEDED if the finalize stage has not yet been called.

getEnterpriseId

long getEnterpriseId()

Returns the enterprise ID of the request. It is determined by the enterprise ID of the submitter of the request.

Returns:

the enterprise ID of the submitter of the request

toString

java.lang.String toString()

Returns a String representation of this object suitable for use in a web service call such as setAsyncRequestStatus.

Overrides:

toString in class java.lang.Object

Returns:

a String representation of this object.

toIdString

java.lang.String toIdString()

Returns a String representation of this object suitable for use as a web service message ID.

Returns:

a String representation of this object.

Skip navigation links