Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Enterprise Scheduler Service
11g Release 1 (11.1.1.6.3)
E26229-05


oracle.as.scheduler
Class RequestDetail

java.lang.Object
  extended by oracle.as.scheduler.RequestDetail

All Implemented Interfaces:
java.io.Serializable

public class RequestDetail
extends java.lang.Object
implements java.io.Serializable

Encapsulates the runtime data associated with a request.

See Also:
Serialized Form

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.
 JobSet.ExecutionMode getExecutionMode()
          Gets the execution mode of a JobSet 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.
 RequestMode getRequestMode()
          Gets the request mode of request.
 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 isAsyncRecoverable()
          Indicates if the request is eligible for recovery using RuntimeServiceMXBeanProxy.completeAsyncRequest(long, oracle.as.scheduler.async.AsyncStatus, java.lang.String)
 boolean isCancellable()
          Indicates if the request is cancellable.
 boolean isHoldable()
          Indicates if the request is holdable.
 boolean isRecoverable()
          Indicates if the request is eligible for recovery using RuntimeServiceMXBeanProxy.recoverRequest(long)
 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

RequestDetail

protected RequestDetail(java.util.Map<RequestDetail.RequestDetailField,java.lang.Object> params,
                        boolean isSparse)

RequestDetail

@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. 
Constructs a new instance using the specified parameters. This constructor is used to create a sparse RequestDetail returned by some methods of the Runtime MBean interface.

RequestDetail

@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. 
Constructs a new instance using the specified parameters.

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

getRequestId

public long getRequestId()
Gets the request identifier associated with these details.
Returns:
request identifier.

getDescription

public java.lang.String getDescription()
Gets the description of this request.
Returns:
request description.

getApplication

public java.lang.String getApplication()
Gets the application name associated with this request.
Returns:
the application name

getDeployedApplication

public java.lang.String getDeployedApplication()
Gets the physical J2EE application deployment name associated with this request.
Returns:
the application name

getJobDefn

public MetadataObjectId getJobDefn()
Returns the job or job set definition identifier associated with this request. A request submitted as an adhoc request might not have a job or job set metadata identifer.
Returns:
job or job set identifier. This will be null if no metatdata as used for this request.

getJobType

public MetadataObjectId getJobType()
Returns the job type identifier associated with this request. A request submitted as an adhoc request might not have a job type metadata identifer.
Returns:
job type identifier. This will be null if no metatdata as used for this request.

getScheduleDefn

public MetadataObjectId getScheduleDefn()
Returns the schedule definition identifier associated with this request.
Returns:
schedule identifier, or null if no schedule metadata was used for this request.

getTriggerDefn

public MetadataObjectId getTriggerDefn()
Returns the trigger definition identifier associated with this request.
Returns:
trigger identifier, or null if no trigger metadata was used for this specified.

getProcessingDispatcher

public java.lang.String getProcessingDispatcher()
Returns the OC4J instance name that dispatched the request.
Returns:
instance name, or null if request not dispatched.

getProcessingProcessor

public java.lang.String getProcessingProcessor()
Returns the OC4J instance name that processed the request.
Returns:
instance name, or null if request not processed.

getProcessingWorkAssignment

public MetadataObjectId getProcessingWorkAssignment()
Returns the work assignment that was active on the request processor when the request was processed.
Returns:
work assignment identifier, or null if not applicable.

getProcessingWorkshift

public MetadataObjectId getProcessingWorkshift()
Returns the work shift that was active on the request processor when the request was processed.
Returns:
work shift identifier, or null if not applicable.

getExecutionAttempt

public int getExecutionAttempt()
Returns the current execution attempt for this request. The first execution attempt is 1.
Returns:
current execution attempt

getRetriedCount

public int getRetriedCount()
Returns the number of times this request has been retried.
Returns:
the number of times request has been retried.

isCancellable

public boolean isCancellable()
Indicates if the request is cancellable.

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.

Returns:
true if cancellable, or false otherwise.

isHoldable

public boolean isHoldable()
Indicates if the request is holdable.

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.

Returns:
true if request can be held, false otherwise.

getSubmitter

public java.lang.String getSubmitter()
Gets the user name who submitted the request.
Returns:
the user name.

getSubmitterGuid

public java.lang.String getSubmitterGuid()
Gets the user GUID who submitted the request.
Returns:
the user guid.

getRunAsUser

public java.lang.String getRunAsUser()
Gets the RunAs user for the request.
Returns:
the RunAs user for the request

getRequestedStartTime

public java.util.Calendar getRequestedStartTime()
Gets the requested start time of the request.
Returns:
time at which the request was to start.

getRequestedEndTime

public java.util.Calendar getRequestedEndTime()
Gets the requested end time of the request.
Returns:
time at which request was to end. This will be null if an end time was not specified.

getScheduledTime

public java.util.Calendar getScheduledTime()
Gets the scheduled start time of the request.
Returns:
time at which request is scheduled to run.

getTriggerState

public org.w3c.dom.Document getTriggerState()
Returns the detailed state for the trigger associated with this request.
Returns:
an XML document representative of the state. This will be null if not applicable.

getTriggerEvaluationStatus

public boolean getTriggerEvaluationStatus()
Returns the evaluation status of the trigger for this request.

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.

Returns:
true if the associated trigger fired for this request, false otherwise.

getCause

public Cause getCause()
Returns the cause that lead to the request being placed in a terminal state.
Returns:
the cause associated with a request's terminal state.

getParent

public long getParent()
Returns the immediate parent request id for this request. If the request has no immediate parent, the value returned by this method as not meaningful.
Returns:
the parent id for this request.

getAbsoluteParentId

public long getAbsoluteParentId()
Returns absolute parent request id for this request.

The absolute parent id is the submitted request id. All child requests created on behalf of that request have the same absolute parent.

Returns:
absolute parent id for this request.

getInstanceParentId

public long getInstanceParentId()
Returns instance parent request id for this request.

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.

Returns:
instance parent id for this request.

getStepID

public java.lang.String getStepID()
The stepID for this request.

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.

Returns:
the step ID for this request.

getState

public State getState()
Gets the state for this request.
Returns:
the request state.

getErrorType

public ErrorType getErrorType()
Gets the error type for this request.
Returns:
error type

getRequestType

public RequestType getRequestType()
Gets the request type of request.
Returns:
the request type.

getPriority

public int getPriority()
Gets the request priority. The priorty ranges 0..9.
Returns:
the request priority.

getType

public java.lang.String getType()
Return the execution type of this request. This method returns one of the following string values to represent the execution type.
Returns:
the execution type represented as a string.

getRequestCategory

public java.lang.String getRequestCategory()
Returns the request category system property for this request.
Returns:
the request category.

getSchedule

public Schedule getSchedule()
Returns schedule instance associated with this request.
Returns:
the schedule instance, or null if no schedule is associated with the request.

getTrigger

public Trigger getTrigger()
Returns trigger instance associated with request.
Returns:
the trigger instance, or null if no trigger is associated with this request.

getParameters

public RequestParameters getParameters()
Returns all the parameters, including system properties, associated with this request.
Returns:
the request parameters.

getSubmissionTime

public java.util.Calendar getSubmissionTime()
Returns the time at which the request was submitted.
Returns:
the submission time.

getStartTime

public java.util.Calendar getStartTime()
Returns the time that processing of this request commenced.

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.

Returns:
the time request processing started, or null if request processing has not started.

getEndTime

public java.util.Calendar getEndTime()
Returns the time that processing of this request ended.

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.

Returns:
the time that processing ended, or null if request processing has not ended.

getCompletedTime

public java.util.Calendar getCompletedTime()
Returns the time that ESS finished all tasks associated with this request. This represents the time that the request process phase was set to 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.

Returns:
the time ESS finished the request, or null if ESS has not yet finished all work for this requests.

getExpiration

public java.util.Calendar getExpiration()
Returns the time that the request will expire. A request may not expire.
Returns:
the time the request expires, or null if the request never expires.

getElapsedMillis

public long getElapsedMillis()
The elapsed milliseconds spent processing request.
Returns:
elapsed run time for request. This will be zero (0L) if the request processing not started.

getErrorWarningMessage

public java.lang.String getErrorWarningMessage()
Returns the message associated with an error/warning occured while processing this request.
Returns:
the value of the error/warning message.

getErrorWarningTime

public java.util.Calendar getErrorWarningTime()
Returns the time of error/warning occured while processing this request.
Returns:
the time of occurance of error/warning

getErrorWarningDetail

public java.lang.String getErrorWarningDetail()
Returns the stack trace of error/warning occured while processing this request.
Returns:
the detailed content of error/warning

getECID

public java.lang.String getECID()
Return the ECID associated with the ExecutionContext at the time of the request submission.
Returns:
the string representation of the ECID

getProduct

public java.lang.String getProduct()
Return the product associated with the request. If the SYS_product is not specified, this returns null.
Returns:
the product set in the request

getProcessPhase

public ProcessPhase getProcessPhase()
Return the process phase for this request.
Returns:
process phase

getLastScheduleInstanceId

public long getLastScheduleInstanceId()
Returns the last Schedule instance request id associated with this request. This value is meaningful only for certain request types. For other request types it is meaningless and will be zero (0).

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.

Returns:
the id of last schedule instance request

getEnterpriseId

public long getEnterpriseId()
Returns the enterprise ID of the request. It is determined by the enterprise ID of the submitter of the request.
Returns:
the enterprise ID of the submitter of the request

getProcessGroup

public java.lang.String getProcessGroup()
Returns the process group of the request.

isAsynchronous

public java.lang.Boolean isAsynchronous()
Indicates if the request is asynchronous.
Returns:
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.

isTimedOut

public boolean isTimedOut()
Indicates if the request has timed out.

See SystemProperty.ASYNC_REQUEST_TIMEOUT.

Returns:
true if the request has timed out, false otherwise

getParentExecAttempt

public int getParentExecAttempt()
The value of execution attempt of the immediate parent request when this request was created. This value will be zero if this request does not have an immediate parent.
Returns:
the immediate parent's execution attempt

getInstanceParentExecAttempt

public int getInstanceParentExecAttempt()
The value of execution attempt of the instance parent request when this request was created. This value will be zero if this request does not have an instance parent.
Returns:
the instance parent's execution attempt

getPausedCount

public int getPausedCount()
The number of times this request has been paused during its current execution attempt. This value is incremented when a request has been paused to allow to allow sub-requests to run. This value will be zero if this request has never been paused.
Returns:
the paused count for this request

getLastSubrequestSet

public int getLastSubrequestSet()
The set number assigned to the last subrequest submitted by this request during its current execution attempt. This value will be zero if no subrequests have been submitted by this request.

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.

Returns:
the set number assigned to the last submitted subrequest

getSubrequestSet

public int getSubrequestSet()
The set number assigned to a subrequest when it was submitted. If a parent submits multiple subrequests before it pauses all those subrequests will have the same set number.

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.

Returns:
the set number assigned to a subrequest

getPreProcessStatus

@Deprecated
public java.lang.String getPreProcessStatus()
Deprecated. Replaced by getPreProcessHandlerStatus().
The status returned by the pre-processor for this request.
Returns:
the pre-processor status

getPreProcessHandlerStatus

public HandlerStatus getPreProcessHandlerStatus()
The status of the pre-processing stage for this request.
Returns:
the pre-processor status or null if the pre-processor has not completed.

getPreProcessMessage

public java.lang.String getPreProcessMessage()
The action message returned by the pre-processor for this request.
Returns:
the pre-processor action message

getPostProcessStatus

@Deprecated
public java.lang.String getPostProcessStatus()
Deprecated. Replaced by getPostProcessHandlerStatus().
The status returned by the post-processor for this request.
Returns:
the post-processor status

getPostProcessHandlerStatus

public HandlerStatus getPostProcessHandlerStatus()
The status of the post-processing stage for this request.
Returns:
the post-processor status or null if the pre-processor has not completed.

getPostProcessMessage

public java.lang.String getPostProcessMessage()
The action message returned by the post-processor for this request.
Returns:
the post-processor action message

getExecutableStatus

@Deprecated
public java.lang.String getExecutableStatus()
Deprecated. Replaced by getExecutableState().
The status of the request when the executable stage completed.
Returns:
the executable stage state

getExecutableState

public State getExecutableState()
The state of the request when the executable stage completed.
Returns:
the executable stage state or null if the executable stage has not completed.

isAsyncRecoverable

public boolean isAsyncRecoverable()
Indicates if the request is eligible for recovery using RuntimeServiceMXBeanProxy.completeAsyncRequest(long, oracle.as.scheduler.async.AsyncStatus, java.lang.String)

This is based on the type and current status of this request. This is only a hint, not a guarantee, whether this request can be recovered in this fashion. Note that the status may have changed by the time the recovery operation is invoked

Returns:
true if the request is eligible for recovery using RuntimeServiceMXBeanProxy.completeAsyncRequest(long, oracle.as.scheduler.async.AsyncStatus, java.lang.String) , false otherwise.

isRecoverable

public boolean isRecoverable()
Indicates if the request is eligible for recovery using RuntimeServiceMXBeanProxy.recoverRequest(long)

This is based on the type and current status of this request. This is only a hint, not a guarantee, whether this request can be recovered in this fashion. Note that the status may have changed by the time the recovery operation is invoked.

Returns:
true if the request is eligible for recovery using RuntimeServiceMXBeanProxy.recoverRequest(long) , false otherwise.

getRequestMode

public RequestMode getRequestMode()
Gets the request mode of request.
Returns:
the request mode.

getExecutionMode

public JobSet.ExecutionMode getExecutionMode()
Gets the execution mode of a JobSet request.
Returns:
JobSet execution mode.

toCompositeType

public static javax.management.openmbean.CompositeType toCompositeType()
Returns the CompositeType that describes this model specific class

toCompositeData

public javax.management.openmbean.CompositeData toCompositeData(javax.management.openmbean.CompositeType ct)
Convert an instance of this model specific type to a CompositeData. This ensure that clients that do not have access to the model specific class can still use the MBean. The MXBean framework can perform this conversion automatically. However MXBeans are part of JDK 6.0 and AS11g is required to support JDK 5.0
Parameters:
ct - This parameter is there only for future compatibility reasons with JDK 6.0. It can be ignored at this point.

from

public static RequestDetail from(javax.management.openmbean.CompositeData cd)
                          throws java.lang.IllegalArgumentException
Create an instance of the model specific class out of an associated CompositeData instance
Throws:
java.lang.IllegalArgumentException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Enterprise Scheduler Service
11g Release 1 (11.1.1.6.3)
E26229-05


Copyright © 2008, 2012 Oracle. All rights reserved.