oracle.as.scheduler
Class ExecutionPausedException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          oracle.as.scheduler.SchedulerException
              oracle.as.scheduler.ExecutionPausedException

All Implemented Interfaces:

java.io.Serializable

public final class ExecutionPausedException
extends SchedulerException

Exception used by the Executable interface to indicate request execution should be paused to allow submitted sub-requests to execute.

A request executable that submits a sub-request must pause before the sub-request will be executed. After a job Executable submits a sub-request, this exception must thrown by the request executable so the Scheduler subsystem will pause the request.

An application paused state value can be associated with this exception. The paused state will be available to the resumed request via the request execution context when the request is resumed.

See Also:

Executable, Serialized Form

Constructor Summary

ExecutionPausedException()
Constructs a new exception with null detail message and null paused state.

ExecutionPausedException(java.lang.String message)
Constructs a new exception with the specified detail message and null paused state.

ExecutionPausedException(java.lang.String message, java.lang.String state)
Constructs a new exception with the specified detail message and paused state.

Method Summary

java.lang.String	getPausedState() Gets the paused state associated with this exception.
void	setPausedState(java.lang.String state) Sets the paused state associated with this exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExecutionPausedException

public ExecutionPausedException()

Constructs a new exception with null detail message and null paused state. The cause is not initialized.

ExecutionPausedException

public ExecutionPausedException(java.lang.String message)

Constructs a new exception with the specified detail message and null paused state. The cause is not initialized.

Parameters:

message - the detail message. This can be retrieved by the getMessage method.

ExecutionPausedException

public ExecutionPausedException(java.lang.String message,
                                java.lang.String state)

Constructs a new exception with the specified detail message and paused state. The cause is not initialized.

The paused state will be made available to the request executable once the sub-requests have completed and the request is resumed.

Parameters:

message - the detail message. This can be retrieved by the getMessage method.

state - the application-specified paused state. This can be retrieved by the getPausedState method.

Method Detail

getPausedState

public java.lang.String getPausedState()

Gets the paused state associated with this exception.

Returns:

the paused state, or null if none

setPausedState

public void setPausedState(java.lang.String state)

Sets the paused state associated with this exception.

Parameters:

state - the application-specified paused state. This can be null.