|
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 |
java.lang.Object oracle.as.scheduler.RequestDetail
public class RequestDetail
Encapsulates the runtime data associated with a request.
Nested Class Summary | |
---|---|
protected static class |
RequestDetail.RequestDetailField
|
Constructor Summary | |
---|---|
protected |
RequestDetail(long requestId,
java.lang.String descr,
MetadataObjectId jobDefnId,
boolean isCancellable,
boolean isHoldable,
java.lang.String submitter,
java.lang.String submitterGuid,
java.lang.String runAsUser,
java.util.Calendar scheduledTime,
State state,
ErrorType errorType,
java.lang.String type,
java.lang.String requestCategory,
java.util.Calendar processStart,
java.util.Calendar processEnd,
long parentID,
int priority,
long absoluteParentId,
java.lang.String application,
java.lang.String deployedApplication,
RequestType requestType,
java.util.Calendar submission,
long instanceParentId,
java.lang.String ecid,
java.lang.String product,
ProcessPhase processPhase,
long lastScheduleInstanceId,
java.util.Calendar completedTime,
long elapsedTime,
int retried,
MetadataObjectId jobTypeId,
long enterpriseId,
java.lang.String processGroup,
java.lang.String processingProcessor,
java.lang.Boolean isAsynchronous,
boolean isRequestTimedOut,
int parentExecAttempt,
int instanceParentExecAttempt,
int pausedCount,
int lastSubrequestSet,
int subrequestSet)
Deprecated. |
protected |
RequestDetail(long requestId,
java.lang.String descr,
MetadataObjectId jobDefnId,
MetadataObjectId scheduleDefnId,
MetadataObjectId triggerDefnId,
java.lang.String processingDispatcher,
java.lang.String processingProcessor,
MetadataObjectId processingWorkAssignmentId,
MetadataObjectId processingWorkShiftId,
boolean isCancellable,
boolean isHoldable,
int retried,
int executionAttempt,
java.lang.String submitter,
java.lang.String submitterGuid,
java.lang.String runAsUser,
java.util.Calendar requestedStartTime,
java.util.Calendar requestedEndTime,
java.util.Calendar scheduledTime,
State state,
ErrorType errorType,
int priority,
java.lang.String type,
java.lang.String requestCategory,
java.util.Calendar submission,
java.util.Calendar processStart,
java.util.Calendar processEnd,
java.util.Calendar expiration,
Cause cause,
long parentID,
java.lang.String stepID,
RequestParameters reqParams,
Schedule schedule,
Trigger trigger,
org.w3c.dom.Document triggerState,
long absoluteParentId,
java.lang.String application,
java.lang.String deployedApplication,
RequestType requestType,
long instanceParentId,
java.lang.String errorWarningMessage,
java.util.Calendar errorWarningTime,
java.lang.String errorWarningDetail,
java.lang.String ecid,
java.lang.String product,
ProcessPhase processPhase,
long lastScheduleInstanceId,
java.util.Calendar completedTime,
long elapsedTime,
MetadataObjectId jobTypeId,
long enterpriseId,
java.lang.String processGroup,
java.lang.Boolean isAsynchronous,
boolean isRequestTimedOut,
int parentExecAttempt,
int instanceParentExecAttempt,
int pausedCount,
int lastSubrequestSet,
int subrequestSet,
java.lang.String preProcessStatus,
java.lang.String preProcessMessage,
java.lang.String postProcessStatus,
java.lang.String postProcessMessage,
java.lang.String executableStatus)
Deprecated. |
protected |
RequestDetail(java.util.Map<RequestDetail.RequestDetailField,java.lang.Object> params,
boolean isSparse)
|
Method Summary | |
---|---|
static RequestDetail |
from(javax.management.openmbean.CompositeData cd)
Create an instance of the model specific class out of an associated CompositeData instance |
long |
getAbsoluteParentId()
Returns absolute parent request id for this request. |
java.lang.String |
getApplication()
Gets the application name associated with this request. |
Cause |
getCause()
Returns the cause that lead to the request being placed in a terminal state. |
java.util.Calendar |
getCompletedTime()
Returns the time that ESS finished all tasks associated with this request. |
java.lang.String |
getDeployedApplication()
Gets the physical J2EE application deployment name associated with this request. |
java.lang.String |
getDescription()
Gets the description of this request. |
java.lang.String |
getECID()
Return the ECID associated with the ExecutionContext at the time of the request submission. |
long |
getElapsedMillis()
The elapsed milliseconds spent processing request. |
java.util.Calendar |
getEndTime()
Returns the time that processing of this request ended. |
long |
getEnterpriseId()
Returns the enterprise ID of the request. |
ErrorType |
getErrorType()
Gets the error type for this request. |
java.lang.String |
getErrorWarningDetail()
Returns the stack trace of error/warning occured while processing this request. |
java.lang.String |
getErrorWarningMessage()
Returns the message associated with an error/warning occured while processing this request. |
java.util.Calendar |
getErrorWarningTime()
Returns the time of error/warning occured while processing this request. |
State |
getExecutableState()
The state of the request when the executable stage completed. |
java.lang.String |
getExecutableStatus()
Deprecated. Replaced by getExecutableState() . |
int |
getExecutionAttempt()
Returns the current execution attempt for this request. |
java.util.Calendar |
getExpiration()
Returns the time that the request will expire. |
int |
getInstanceParentExecAttempt()
The value of execution attempt of the instance parent request when this request was created. |
long |
getInstanceParentId()
Returns instance parent request id for this request. |
MetadataObjectId |
getJobDefn()
Returns the job or job set definition identifier associated with this request. |
MetadataObjectId |
getJobType()
Returns the job type identifier associated with this request. |
long |
getLastScheduleInstanceId()
Returns the last Schedule instance request id associated with this request. |
int |
getLastSubrequestSet()
The set number assigned to the last subrequest submitted by this request during its current execution attempt. |
RequestParameters |
getParameters()
Returns all the parameters, including system properties, associated with this request. |
long |
getParent()
Returns the immediate parent request id for this request. |
int |
getParentExecAttempt()
The value of execution attempt of the immediate parent request when this request was created. |
int |
getPausedCount()
The number of times this request has been paused during its current execution attempt. |
HandlerStatus |
getPostProcessHandlerStatus()
The status of the post-processing stage for this request. |
java.lang.String |
getPostProcessMessage()
The action message returned by the post-processor for this request. |
java.lang.String |
getPostProcessStatus()
Deprecated. Replaced by getPostProcessHandlerStatus() . |
HandlerStatus |
getPreProcessHandlerStatus()
The status of the pre-processing stage for this request. |
java.lang.String |
getPreProcessMessage()
The action message returned by the pre-processor for this request. |
java.lang.String |
getPreProcessStatus()
Deprecated. Replaced by getPreProcessHandlerStatus() . |
int |
getPriority()
Gets the request priority. |
java.lang.String |
getProcessGroup()
Returns the process group of the request. |
java.lang.String |
getProcessingDispatcher()
Returns the OC4J instance name that dispatched the request. |
java.lang.String |
getProcessingProcessor()
Returns the OC4J instance name that processed the request. |
MetadataObjectId |
getProcessingWorkAssignment()
Returns the work assignment that was active on the request processor when the request was processed. |
MetadataObjectId |
getProcessingWorkshift()
Returns the work shift that was active on the request processor when the request was processed. |
ProcessPhase |
getProcessPhase()
Return the process phase for this request. |
java.lang.String |
getProduct()
Return the product associated with the request. |
java.lang.String |
getRequestCategory()
Returns the request category system property for this request. |
java.util.Calendar |
getRequestedEndTime()
Gets the requested end time of the request. |
java.util.Calendar |
getRequestedStartTime()
Gets the requested start time of the request. |
long |
getRequestId()
Gets the request identifier associated with these details. |
RequestType |
getRequestType()
Gets the request type of request. |
int |
getRetriedCount()
Returns the number of times this request has been retried. |
java.lang.String |
getRunAsUser()
Gets the RunAs user for the request. |
Schedule |
getSchedule()
Returns schedule instance associated with this request. |
MetadataObjectId |
getScheduleDefn()
Returns the schedule definition identifier associated with this request. |
java.util.Calendar |
getScheduledTime()
Gets the scheduled start time of the request. |
java.util.Calendar |
getStartTime()
Returns the time that processing of this request commenced. |
State |
getState()
Gets the state for this request. |
java.lang.String |
getStepID()
The stepID for this request. |
java.util.Calendar |
getSubmissionTime()
Returns the time at which the request was submitted. |
java.lang.String |
getSubmitter()
Gets the user name who submitted the request. |
java.lang.String |
getSubmitterGuid()
Gets the user GUID who submitted the request. |
int |
getSubrequestSet()
The set number assigned to a subrequest when it was submitted. |
Trigger |
getTrigger()
Returns trigger instance associated with request. |
MetadataObjectId |
getTriggerDefn()
Returns the trigger definition identifier associated with this request. |
boolean |
getTriggerEvaluationStatus()
Returns the evaluation status of the trigger for this request. |
org.w3c.dom.Document |
getTriggerState()
Returns the detailed state for the trigger associated with this request. |
java.lang.String |
getType()
Return the execution type of this request. |
java.lang.Boolean |
isAsynchronous()
Indicates if the request is asynchronous. |
boolean |
isCancellable()
Indicates if the request is cancellable. |
boolean |
isHoldable()
Indicates if the request is holdable. |
boolean |
isTimedOut()
Indicates if the request has timed out. |
javax.management.openmbean.CompositeData |
toCompositeData(javax.management.openmbean.CompositeType ct)
Convert an instance of this model specific type to a CompositeData. |
static javax.management.openmbean.CompositeType |
toCompositeType()
Returns the CompositeType that describes this model specific class |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected RequestDetail(java.util.Map<RequestDetail.RequestDetailField,java.lang.Object> params, boolean isSparse)
@Deprecated protected RequestDetail(long requestId, java.lang.String descr, MetadataObjectId jobDefnId, boolean isCancellable, boolean isHoldable, java.lang.String submitter, java.lang.String submitterGuid, java.lang.String runAsUser, java.util.Calendar scheduledTime, State state, ErrorType errorType, java.lang.String type, java.lang.String requestCategory, java.util.Calendar processStart, java.util.Calendar processEnd, long parentID, int priority, long absoluteParentId, java.lang.String application, java.lang.String deployedApplication, RequestType requestType, java.util.Calendar submission, long instanceParentId, java.lang.String ecid, java.lang.String product, ProcessPhase processPhase, long lastScheduleInstanceId, java.util.Calendar completedTime, long elapsedTime, int retried, MetadataObjectId jobTypeId, long enterpriseId, java.lang.String processGroup, java.lang.String processingProcessor, java.lang.Boolean isAsynchronous, boolean isRequestTimedOut, int parentExecAttempt, int instanceParentExecAttempt, int pausedCount, int lastSubrequestSet, int subrequestSet)
@Deprecated protected RequestDetail(long requestId, java.lang.String descr, MetadataObjectId jobDefnId, MetadataObjectId scheduleDefnId, MetadataObjectId triggerDefnId, java.lang.String processingDispatcher, java.lang.String processingProcessor, MetadataObjectId processingWorkAssignmentId, MetadataObjectId processingWorkShiftId, boolean isCancellable, boolean isHoldable, int retried, int executionAttempt, java.lang.String submitter, java.lang.String submitterGuid, java.lang.String runAsUser, java.util.Calendar requestedStartTime, java.util.Calendar requestedEndTime, java.util.Calendar scheduledTime, State state, ErrorType errorType, int priority, java.lang.String type, java.lang.String requestCategory, java.util.Calendar submission, java.util.Calendar processStart, java.util.Calendar processEnd, java.util.Calendar expiration, Cause cause, long parentID, java.lang.String stepID, RequestParameters reqParams, Schedule schedule, Trigger trigger, org.w3c.dom.Document triggerState, long absoluteParentId, java.lang.String application, java.lang.String deployedApplication, RequestType requestType, long instanceParentId, java.lang.String errorWarningMessage, java.util.Calendar errorWarningTime, java.lang.String errorWarningDetail, java.lang.String ecid, java.lang.String product, ProcessPhase processPhase, long lastScheduleInstanceId, java.util.Calendar completedTime, long elapsedTime, MetadataObjectId jobTypeId, long enterpriseId, java.lang.String processGroup, java.lang.Boolean isAsynchronous, boolean isRequestTimedOut, int parentExecAttempt, int instanceParentExecAttempt, int pausedCount, int lastSubrequestSet, int subrequestSet, java.lang.String preProcessStatus, java.lang.String preProcessMessage, java.lang.String postProcessStatus, java.lang.String postProcessMessage, java.lang.String executableStatus)
The application
argument will be used for the application value
associated with this object only if no request parameters are specified.
If request parameters are given, then getApplication
method
returns the value of APPLICATION system property and the
application
parameter will be ignored and can be null.
Similarly, getProduct
method returns the value of
PRODUCT system property and the product
parameter
will be ignored and can be null.
Method Detail |
---|
public long getRequestId()
public java.lang.String getDescription()
public java.lang.String getApplication()
public java.lang.String getDeployedApplication()
public MetadataObjectId getJobDefn()
null
if
no metatdata as used for this request.public MetadataObjectId getJobType()
null
if
no metatdata as used for this request.public MetadataObjectId getScheduleDefn()
null
if no schedule
metadata was used for this request.public MetadataObjectId getTriggerDefn()
null
if no trigger
metadata was used for this specified.public java.lang.String getProcessingDispatcher()
null
if request not dispatched.public java.lang.String getProcessingProcessor()
null
if request not processed.public MetadataObjectId getProcessingWorkAssignment()
null
if not applicable.public MetadataObjectId getProcessingWorkshift()
null
if not applicable.public int getExecutionAttempt()
public int getRetriedCount()
public boolean isCancellable()
This is based on the request type and current state of this request. This is only a hint, not a guarantee, as to whether or not this request can be cancelled.
true
if cancellable, or false
otherwise.public boolean isHoldable()
This is based on the request type and current state of this request. This is only a hint, not a guarantee, as to whether or not this request can be held.
true
if request can be held, false
otherwise.public java.lang.String getSubmitter()
public java.lang.String getSubmitterGuid()
public java.lang.String getRunAsUser()
public java.util.Calendar getRequestedStartTime()
public java.util.Calendar getRequestedEndTime()
null
if an end time was not specified.public java.util.Calendar getScheduledTime()
public org.w3c.dom.Document getTriggerState()
null
if not applicable.public boolean getTriggerEvaluationStatus()
The method returns false
if there is no trigger associated
with this request. If a trigger is associated, the return value
depends on whether the trigger evaluated to true (triggering
execution of this request) or false.
Calling this method on a parent request will always return
false
because the trigger for a parent request, if any,
always gets reset for subsequent evaluations.
true
if the associated trigger fired for this request,
false
otherwise.public Cause getCause()
public long getParent()
public long getAbsoluteParentId()
The absolute parent id is the submitted request id. All child requests created on behalf of that request have the same absolute parent.
public long getInstanceParentId()
If a request is submitted with a Schedule, a new child request is created for each occurance of that Schedule. Similarly, if a request is created with a Trigger, a child request is created each time the Trigger condition is satisified. The insance parent id represents the id of that top-most child request. Any child requests of that request, such as sub-requests or JobSet step request, have the same instance parent id.
If a request is submitted without a Schedule or Trigger, then that submitted request is considered the instance parent, and the instance parent id value is the same as the absolute parent id.
public java.lang.String getStepID()
This is primarily used for internal purposes. The request may or may not be a step within a JobSet, and typically the stepID value indicates that.
public State getState()
public ErrorType getErrorType()
public RequestType getRequestType()
public int getPriority()
public java.lang.String getType()
JAVA_TYPE
for a Java job request
SQL_TYPE
for a SQL job request.
PROCESS_TYPE
for a process job request.
public java.lang.String getRequestCategory()
public Schedule getSchedule()
null
if no schedule is
associated with the request.public Trigger getTrigger()
null
if no trigger is
associated with this request.public RequestParameters getParameters()
public java.util.Calendar getSubmissionTime()
public java.util.Calendar getStartTime()
This value may never be set for some requests. For example, if a request was cancelled prior to it being executed, if the request expired prior to it being executed, if the submit validation failed for the request, and so on.
null
if request
processing has not started.public java.util.Calendar getEndTime()
This value may never be set for some requests. For example, if a request was cancelled prior to it being executed, if the request expired prior to it being executed, if the submit validation failed for the request, and so on.
null
if request
processing has not ended.public java.util.Calendar getCompletedTime()
ProcessPhase.Complete
.
This value will always be set once all tasks for the request has finished, even if the request was never executed for some reason.
null
if ESS has
not yet finished all work for this requests.public java.util.Calendar getExpiration()
null
if the
request never expires.public long getElapsedMillis()
public java.lang.String getErrorWarningMessage()
public java.util.Calendar getErrorWarningTime()
public java.lang.String getErrorWarningDetail()
public java.lang.String getECID()
public java.lang.String getProduct()
public ProcessPhase getProcessPhase()
public long getLastScheduleInstanceId()
For a RequestType.RECUR_PARENT
or
RequestType.JOBSET_RECUR_PARENT
request, this value represents
the id of the instance parent request that was most recently created.
If the Schedule has ended, or been cancelled, this is the id of the
last instance request created for the Schedule.
For a RequestType.RECUR_CHILD
or
RequestType.JOBSET_RECUR_CHILD
request, this value represents
the id of the request for the previous instance of the Schedule.
The value is zero (0) for the first instance request of the Schedule.
public long getEnterpriseId()
public java.lang.String getProcessGroup()
public java.lang.Boolean isAsynchronous()
true
if the request is known to be asynchronous,
false
if the request is known to be synchronous,
null
if it has not yet been determined.public boolean isTimedOut()
See SystemProperty.ASYNC_REQUEST_TIMEOUT
.
true
if the request has timed out, false
otherwisepublic int getParentExecAttempt()
public int getInstanceParentExecAttempt()
public int getPausedCount()
public int getLastSubrequestSet()
If getPausedCount()
equals getLastSubrequestSet
, then
this request has paused since the last subrequests were submitted.
This value represents the set number assigned to those subrequests.
If getPausedCount
is not equal to getLastSubrequestSet
,
then one or more subrequests have been submitted since this request
last paused. This value represents the set number assigned to those
subrequests that are waiting for this request to pause.
public int getSubrequestSet()
This is meaningful only for a subrequest, in which case this value will be greater than zero. The value is zero for a request that is not a subrequest.
@Deprecated public java.lang.String getPreProcessStatus()
getPreProcessHandlerStatus()
.
public HandlerStatus getPreProcessHandlerStatus()
null
if the pre-processor
has not completed.public java.lang.String getPreProcessMessage()
@Deprecated public java.lang.String getPostProcessStatus()
getPostProcessHandlerStatus()
.
public HandlerStatus getPostProcessHandlerStatus()
null
if the pre-processor
has not completed.public java.lang.String getPostProcessMessage()
@Deprecated public java.lang.String getExecutableStatus()
getExecutableState()
.
public State getExecutableState()
null
if the executable
stage has not completed.public static javax.management.openmbean.CompositeType toCompositeType()
public javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType ct)
ct
- This parameter is there only for future compatibility reasons
with JDK 6.0. It can be ignored at this point.public static RequestDetail from(javax.management.openmbean.CompositeData cd) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
public java.lang.String toString()
toString
in class java.lang.Object
|
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 |