Package oracle.as.scheduler

Interface RequestExecutionContext

All Superinterfaces:
Serializable
public interface RequestExecutionContext extends 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:

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getEnterpriseId()
    Gets the enterprise ID of the request.
    State
    getExecStageState()
    Gets the state of the job execution.
    String
    getPausedState()
    Gets the paused state specified by the application when this request was previously paused.
    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.
    String
    toIdString()
    Gets a String representation of this object suitable for use as a web service message ID.
    String
    toString()
    Gets a String representation of this object suitable for use in a web service call such as setAsyncRequestStatus.

  • Method Details

    • 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

      String getPausedState()
      Gets the paused state specified by the application when this request was previously paused. For example, this reflects the paused state value retrieved from the ExecutionPausedException used to pause a Java job parent 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.

    • getRequestHandle

      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()
      Gets the state of the job execution. This value is meaningful only to the post-processor as it is set for the request execution context only after the executable has completed.
      Returns:
      state of the job execution, or UNKNOWN if the request executable has not yet been run.

    • getEnterpriseId

      long getEnterpriseId()
      Gets 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

      String toString()
      Gets a String representation of this object suitable for use in a web service call such as setAsyncRequestStatus.
      Overrides:
      toString in class Object
      Returns:
      a String representation of this object.

    • toIdString

      String toIdString()
      Gets a String representation of this object suitable for use as a web service message ID.
      Returns:
      a String representation of this object.