oracle.as.scheduler

Interface Cancellable

public interface Cancellable

Contract by which a client callout handler or Java executable can be cancelled. This interface is typically used as an optional interface that may be implemented for certain Java classes supplied by the client.

The Cancellable interface is supported for the following client classes:

• a pre-process callback that implements PreProcessHandler,
• a post-process callback that implements PostProcessHandler,
• a Java executable class that implements Executable.

When a job request is cancelled, Enterprise Scheduler determines if the client class implements the Cancellable interface, and if so, calls the cancel method to notify the client class of the request cancellation. This cancel method simply informs the job executable or callout handler that the request has been cancelled. Enterprise Scheduler will not actually cancel processing of the request until that job executable or callout handler returns.

There are no strict restrictions on what the job executable or callout handler may do during the cancel call, although the expectation is that it is rather minimal and timely. For example, it may simply set an internal flag that the job logic checks at various points to determine if it should stop its work and return in an appropiate manner.

Method Summary

Modifier and Type	Method and Description
void	cancel() Invoked by Enterprise Scheduler when a job request is cancelled.

Method Detail

cancel

void cancel()

Invoked by Enterprise Scheduler when a job request is cancelled. This method must eventually return control to the caller, ideally in a timely manner.