Skip navigation links

Oracle Enterprise Scheduler Java API Reference
11g Release 1 (11.1.1.7)
E26229-06


oracle.as.scheduler
Interface Event

All Known Implementing Classes:
ApplicationEvent, oracle.as.scheduler.event.EventImpl

public interface Event

Provides lifecycle information about a request. Events are passed to an event listener and provide contextual information about the request. There are two types of events, system events and application events.

System events are published by Enterprise Scheduler during processing of a job request as part of its lifecycle. Client applications can specify an event listener to receive system events for a submitted request.

Application events are published when an application client calls RuntimeService.publishEvent. Application events are used for event based requests that use triggers to define application and/or system events that the request depends on for execution.

See Also:
EventListener, Trigger

Field Summary
static java.lang.String APPLICATION_TYPE
          Application event type.
static java.lang.String NAME
          Event filter field for the event name.
static java.lang.String REQUEST_CANCELLED
          Name of the system event published when request processing was cancelled.
static java.lang.String REQUEST_ERROR
          Name of the system event published when request processing resulted in an error.
static java.lang.String REQUEST_ERROR_MANUAL_RECOVERY
          The name of the system event published when a request transitions to ERROR_MANUAL_RECOVERY state.
static java.lang.String REQUEST_EXPIRED
          Name of the system event published when a request expired before it could be executed.
static java.lang.String REQUEST_FINISHED
          Name of the system event published for a request that was submitted with a shedule or trigger when the schedule has ended (or request expiration has been reached) and all child requests have reached a terminal state.
static java.lang.String REQUEST_INVALID
          Request that was pending validation marked as invalid.
static java.lang.String REQUEST_PAUSED
          Request has been paused for sub-request completion.
static java.lang.String REQUEST_RETRY
          Request will be retried.
static java.lang.String REQUEST_SUCCEEDED
          Name of the system event published when request processing succeeded.
static java.lang.String REQUEST_TIMED_OUT
          The name of the system event published when a request times out.
static java.lang.String REQUEST_VALID
          Request successfully validated.
static java.lang.String REQUEST_WARNING
          Name of the system event published when request processing resulted in a warning.
static java.lang.String SCHEDULE_END
          Schedule associated with request has ended.
static java.lang.String SYSTEM_TYPE
          System event type.
static java.lang.String TYPE
          Event filter field for the event type.
static int UNLIMITED_TIME_TO_LIVE
          Constant for unlimited event time-to-live.
static java.lang.String WS_ASYNC_CALLBACK
          An ESS WebService asynchronous call has been made.

 

Method Summary
 java.lang.String getName()
          Returns the name of the event.
 java.util.Map<java.lang.String,java.lang.Object> getProps()
          Gets the properties associated with the event.
 long getRequestId()
          Returns the request identifier associated with this event.
 int getTimeToLive()
          Returns the time-to-live (TTL), in seconds, that the event should be retained.
 java.lang.String getType()
          Returns the type of the event.

 

Field Detail

NAME

static final java.lang.String NAME
Event filter field for the event name. A Filter on the event name would use the value of this constant for the filter field and the value of the event name for the filter value.
See Also:
Constant Field Values

TYPE

static final java.lang.String TYPE
Event filter field for the event type. A Filter on the event type would use the value of this constant for the filter field and the value of the event type for the filter value.
See Also:
Constant Field Values

UNLIMITED_TIME_TO_LIVE

static final int UNLIMITED_TIME_TO_LIVE
Constant for unlimited event time-to-live. A time-to-live value of zero means unlimited.
See Also:
Constant Field Values

SYSTEM_TYPE

static final java.lang.String SYSTEM_TYPE
System event type. System events are published by the Enterprise Scheduler system.
See Also:
Constant Field Values

APPLICATION_TYPE

static final java.lang.String APPLICATION_TYPE
Application event type. Application events are published by RuntimeService.publishEvent.
See Also:
Constant Field Values

REQUEST_SUCCEEDED

static final java.lang.String REQUEST_SUCCEEDED
Name of the system event published when request processing succeeded.
See Also:
Constant Field Values

REQUEST_WARNING

static final java.lang.String REQUEST_WARNING
Name of the system event published when request processing resulted in a warning.
See Also:
Constant Field Values

REQUEST_ERROR

static final java.lang.String REQUEST_ERROR
Name of the system event published when request processing resulted in an error.
See Also:
Constant Field Values

REQUEST_CANCELLED

static final java.lang.String REQUEST_CANCELLED
Name of the system event published when request processing was cancelled.
See Also:
Constant Field Values

REQUEST_EXPIRED

static final java.lang.String REQUEST_EXPIRED
Name of the system event published when a request expired before it could be executed.
See Also:
Constant Field Values

REQUEST_FINISHED

static final java.lang.String REQUEST_FINISHED
Name of the system event published for a request that was submitted with a shedule or trigger when the schedule has ended (or request expiration has been reached) and all child requests have reached a terminal state. This event is published for the submitted (absolute parent) request.
See Also:
Constant Field Values

REQUEST_PAUSED

static final java.lang.String REQUEST_PAUSED
Request has been paused for sub-request completion. The name of the system event published when a request that submitted sub-requests is paused to allow the sub-requests to complete.
See Also:
Constant Field Values

REQUEST_VALID

static final java.lang.String REQUEST_VALID
Request successfully validated. The name of the system event published when a request that was pending validation has been validated.

This event applies only to requests submitted using the Enterprise Scheduler PLSQL runtime package. Such requests are initially placed in a PENDING_VALIDATION state. This event is published when the request has been successfully validated. The request transitions to WAIT state.

This event is never published for requests submitted using the RuntimeService.submitReqeust method since validation is done during the method call and the request is never placed in pending validation state.

See Also:
State, RuntimeService, Constant Field Values

REQUEST_INVALID

static final java.lang.String REQUEST_INVALID
Request that was pending validation marked as invalid. The name of the system event published when a request that was pending validation failed the validation and has been marked as invalid.

This event applies only to requests submitted using the Enterprise Scheduler PLSQL runtime package. Such requests are initially placed in a PENDING_VALIDATION state. This event is published when the request validation failed. The request transitions to VALIDATION_FAILED state.

This event is never published for requests submitted using the RuntimeService.submitReqeust method since validation is done during the method call and the request is never placed in pending validation state.

See Also:
State, RuntimeService, Constant Field Values

REQUEST_RETRY

static final java.lang.String REQUEST_RETRY
Request will be retried. The name of the system event published when a execution of a request resulted in an error, but the request will be retried rather than going immediately to a terminal state.
See Also:
Constant Field Values

SCHEDULE_END

static final java.lang.String SCHEDULE_END
Schedule associated with request has ended. The name of the system event published when the schedule associated with a request has ended, or the request has expired. This event is also published for requests submitted without an explicit schedule when the request transitions to READY state or the request expires.
See Also:
Constant Field Values

WS_ASYNC_CALLBACK

static final java.lang.String WS_ASYNC_CALLBACK
An ESS WebService asynchronous call has been made. The name of the system event published when an ESS WebService asynchronous call has been made.
See Also:
Constant Field Values

REQUEST_ERROR_MANUAL_RECOVERY

static final java.lang.String REQUEST_ERROR_MANUAL_RECOVERY
The name of the system event published when a request transitions to ERROR_MANUAL_RECOVERY state.
See Also:
State, Constant Field Values

REQUEST_TIMED_OUT

static final java.lang.String REQUEST_TIMED_OUT
The name of the system event published when a request times out. See SystemProperty.ASYNC_REQUEST_TIMEOUT.
See Also:
Constant Field Values

Method Detail

getRequestId

long getRequestId()
Returns the request identifier associated with this event.

If the event is not associated with a specific request, the return value will be zero. For example, application events are never asssociated with an event.

Returns:
the request identifier associated with this event, or zero if none.

getName

java.lang.String getName()
Returns the name of the event.
Returns:
the event name.

getType

java.lang.String getType()
Returns the type of the event.
Returns:
the event type. This will be Event.SYSTEM_TYPE or Event.APPLICATION_TYPE

getProps

java.util.Map<java.lang.String,java.lang.Object> getProps()
Gets the properties associated with the event.
Returns:
the event properties.

getTimeToLive

int getTimeToLive()
Returns the time-to-live (TTL), in seconds, that the event should be retained. A value of UNLIMITED_TIME_TO_LIVE (zero) means unlimited.
Returns:
the event time-to-live.

Skip navigation links

Oracle Enterprise Scheduler Java API Reference
11g Release 1 (11.1.1.7)
E26229-06


Copyright © 2008, 2013, Oracle and/or its affiliates. All rights reserved.