|
Oracle Fusion Applications Java API Reference for Oracle Enterprise Scheduler Service 11g Release 1 (11.1.1.5) E20742-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
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 |
---|
static final java.lang.String NAME
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.
static final java.lang.String TYPE
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.
static final int UNLIMITED_TIME_TO_LIVE
static final java.lang.String SYSTEM_TYPE
static final java.lang.String APPLICATION_TYPE
RuntimeService.publishEvent
.
static final java.lang.String REQUEST_SUCCEEDED
static final java.lang.String REQUEST_WARNING
static final java.lang.String REQUEST_ERROR
static final java.lang.String REQUEST_CANCELLED
static final java.lang.String REQUEST_EXPIRED
static final java.lang.String REQUEST_FINISHED
static final java.lang.String REQUEST_PAUSED
static final java.lang.String REQUEST_VALID
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.
State
,
RuntimeService
,
Constant Field Valuesstatic final java.lang.String REQUEST_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.
State
,
RuntimeService
,
Constant Field Valuesstatic final java.lang.String REQUEST_RETRY
static final java.lang.String SCHEDULE_END
READY
state or the request
expires.
static final java.lang.String WS_ASYNC_CALLBACK
static final java.lang.String REQUEST_ERROR_MANUAL_RECOVERY
ERROR_MANUAL_RECOVERY
state.
State
,
Constant Field Valuesstatic final java.lang.String REQUEST_TIMED_OUT
SystemProperty.ASYNC_REQUEST_TIMEOUT
.
Method Detail |
---|
long getRequestId()
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.
java.lang.String getName()
java.lang.String getType()
Event.SYSTEM_TYPE
or Event.APPLICATION_TYPE
java.util.Map<java.lang.String,java.lang.Object> getProps()
int getTimeToLive()
UNLIMITED_TIME_TO_LIVE
(zero) means
unlimited.
|
Oracle Fusion Applications Java API Reference for Oracle Enterprise Scheduler Service 11g Release 1 (11.1.1.5) E20742-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |