|
Oracle Fusion Middleware Java API Reference for Oracle Enterprise Scheduler Service 11g Release 1 (11.1.1.6.2) E26229-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.as.scheduler.SQLJobDetail
public class SQLJobDetail
This class contains database information associated with an ESS SQL job request. Most of the details are about the Oracle Scheduler job used to run the client's PL/SQL procedure.
The details returned by this class include information for the session used to retrieve the details and information obtained from Oracle Scheduler views. Not all Scheduler information will be available depending on the status of the Oracle Scheduler job.
The getUEnvXXX methods return information about the session used to retrieve the job details. Those details are obtained by calling SYS_CONTEXT function for the 'userenv' environment. These details will always be available.
The getSchedJobName and getSchedJobOwner methods return the name and owner of the Scheduler job. They will always be available as long as any information was available for the Oracle Scheduler job.
The other getSchedJobXXX methods return information obtained from the DBA_SCHEDULER_JOBS view. This information is available only when the Oracle Scheduler job is still exists. Those methods return null if the Oracle Scheduler job does not currently exist.
The getRunningJobXXX methods return information obtained from the DBA_SCHEDULER_RUNNING_JOBS view. This information is available only when the Oracle Scheduler job exists and is currently running. Those methods return null if the Oracle Scheduler job is not running.
The getRunDetailXXX methods return information obtained from the DBA_SCHEDULER_JOB_RUN_DETAIL view. This information is available once the Oracle Scheduler job has completed. Those methods return null if the Oracle Scheduler job has not completed and currently exists.
The getJobRunXXX methods return information for a job that is either running or has completed. Some methods return the same information, in some fashion, as that returned by one of the getRunningJobXXX or getRunDetailXXX method.
A easy way to determine which information is available is check whether certain methods return null; getSchedJobState, getRunningDBInstance, and getRunDetailStatus.
Constructor Summary | |
---|---|
protected |
SQLJobDetail(long requestId, java.lang.String uenvInstanceName, java.lang.String uenvServerHost, java.lang.String schedJobName, java.lang.String schedJobOwner, java.lang.String schedJobState, java.lang.String schedJobEnabled, java.lang.String schedJobClass, java.lang.String schedJobCreator, java.lang.Long runningSessionID, java.lang.Long runningSlaveProcessID, java.lang.String runningSlaveOSProcessID, java.lang.Long runningDBInstance, java.lang.String runningElapsedTime, java.lang.String runningCpuUsed, java.lang.String runningResourceConsumerGroup, java.lang.String runDetailStatus, java.lang.Integer runDetailError, java.util.Calendar runDetailReqStartDate, java.util.Calendar runDetailActualStartDate, java.lang.String runDetailRunDuration, java.lang.Long runDetailInstanceID, java.lang.String runDetailSessionID, java.lang.String runDetailSlavePID, java.lang.String runDetailCpuUsed, java.lang.String runDetailAdditionalInfo, java.lang.Long jobRunInstanceID, java.lang.String jobRunInstanceName, java.lang.Long jobRunSessionID) Construct a new object. |
Method Summary | |
---|---|
static SQLJobDetail |
from(javax.management.openmbean.CompositeData cd) Create an instance of the model specific class out of an associated CompositeData instance |
java.lang.Long |
getJobRunInstanceID() The database instance id on which the Oracle Scheduler job is running or was run if it has completed. |
java.lang.String |
getJobRunInstanceName() The name of the database instance on which the Oracle Scheduler job is running or was run if it has completed. |
java.lang.Long |
getJobRunSessionID() Gets the id of the session used to run the Oracle Scheduler job. |
long |
getRequestId() The ESS request identifier associated with these details. |
java.util.Calendar |
getRunDetailActualStartDate() Gets the actual start date to the Oracle Scheduler job run. |
java.lang.String |
getRunDetailAdditionalInfo() Gets additional information on the Oracle Scheduler job run. |
java.lang.String |
getRunDetailCpuUsed() Gets the amount of CPU used for the Oracle Scheduler job run. |
java.lang.Integer |
getRunDetailError() Gets the error number of a completed Oracle Scheduler job run. |
java.lang.Long |
getRunDetailInstanceID() Gets the identifier of the database instance on which the Oracle Scheduler job run. |
java.util.Calendar |
getRunDetailReqStartDate() Gets the requested start date to the Oracle Scheduler job run. |
java.lang.String |
getRunDetailRunDuration() Gets the duration of the Oracle Scheduler job run. |
java.lang.String |
getRunDetailSessionID() Gets the session identifier of the Oracle Scheduler job run. |
java.lang.String |
getRunDetailSlavePID() Gets the processor identifier of the slave on which the Oracle Scheduler job run. |
java.lang.String |
getRunDetailStatus() Gets the status of a completed Oracle Scheduler job run. |
java.lang.String |
getRunningJobCpuUsed() Gets the CPU time consumed for a running Oracle Scheduler job. |
java.lang.Long |
getRunningJobDBInstance() Gets the database instance number of the slave process running the Oracle Scheduler job. |
java.lang.String |
getRunningJobElapsedTime() Gets the elapsed time of a running Oracle Scheduler job since the job was started. |
java.lang.String |
getRunningJobResourceConsumerGroup() Gets the resource consumer group of the session in which the Oracle Scheduler job is running This returns null the Scheduler job is not currently running. |
java.lang.Long |
getRunningJobSessionID() Gets the identifier of the session running the Oracle Scheduler job. |
java.lang.String |
getRunningJobSlaveOSProcessID() Gets the process number of the OS slave process running the Oracle Scheduler job. |
java.lang.Long |
getRunningJobSlaveProcessID() Gets the process number of the slave process running the Oracle Scheduler job. |
java.lang.String |
getSchedJobClass() Gets the Oracle Scheduler job class associated with the job. |
java.lang.String |
getSchedJobCreator() Gets the creator of the Oracle Scheduler job. |
java.lang.String |
getSchedJobEnabled() Gets the Oracle Scheduler enabled state. |
java.lang.String |
getSchedJobName() The Oracle Scheduler job name used to run the ESS request. |
java.lang.String |
getSchedJobOwner() The owner of the Oracle Scheduler job. |
java.lang.String |
getSchedJobState() The state of the Oracle Scheduler job. |
java.lang.String |
getUEnvInstanceName() The database instance name used to retrieve these details. |
java.lang.String |
getUEnvServerHost() The host name of the machine running the database instance used to retrieve these details. |
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected SQLJobDetail(long requestId, java.lang.String uenvInstanceName, java.lang.String uenvServerHost, java.lang.String schedJobName, java.lang.String schedJobOwner, java.lang.String schedJobState, java.lang.String schedJobEnabled, java.lang.String schedJobClass, java.lang.String schedJobCreator, java.lang.Long runningSessionID, java.lang.Long runningSlaveProcessID, java.lang.String runningSlaveOSProcessID, java.lang.Long runningDBInstance, java.lang.String runningElapsedTime, java.lang.String runningCpuUsed, java.lang.String runningResourceConsumerGroup, java.lang.String runDetailStatus, java.lang.Integer runDetailError, java.util.Calendar runDetailReqStartDate, java.util.Calendar runDetailActualStartDate, java.lang.String runDetailRunDuration, java.lang.Long runDetailInstanceID, java.lang.String runDetailSessionID, java.lang.String runDetailSlavePID, java.lang.String runDetailCpuUsed, java.lang.String runDetailAdditionalInfo, java.lang.Long jobRunInstanceID, java.lang.String jobRunInstanceName, java.lang.Long jobRunSessionID)
Method Detail |
---|
public long getRequestId()
public java.lang.String getUEnvInstanceName()
public java.lang.String getUEnvServerHost()
public java.lang.String getSchedJobName()
public java.lang.String getSchedJobOwner()
public java.lang.String getSchedJobState()
public java.lang.String getSchedJobEnabled()
public java.lang.String getSchedJobClass()
public java.lang.String getSchedJobCreator()
public java.lang.Long getRunningJobSessionID()
public java.lang.Long getRunningJobSlaveProcessID()
public java.lang.String getRunningJobSlaveOSProcessID()
public java.lang.Long getRunningJobDBInstance()
public java.lang.String getRunningJobElapsedTime()
The format will be "DDD HH:MM:SS.ss" where DDD is the number of days, HH is the number of hours, MM is the number of minutes, SS.ss is the is the number of seconds (ss is fractional seconds).
public java.lang.String getRunningJobCpuUsed()
The format will be "DDD HH:MM:SS.ss" where DDD is the number of days, HH is the number of hours, MM is the number of minutes, SS.ss is the is the number of seconds (ss is fractional seconds).
public java.lang.String getRunningJobResourceConsumerGroup()
public java.lang.String getRunDetailStatus()
public java.lang.Integer getRunDetailError()
public java.util.Calendar getRunDetailReqStartDate()
public java.util.Calendar getRunDetailActualStartDate()
public java.lang.String getRunDetailRunDuration()
The format will be "DDD HH:MM:SS" where DDD is the number of days, HH is the number of hours, MM is the number of minutes, and SS is the number of seconds.
public java.lang.Long getRunDetailInstanceID()
public java.lang.String getRunDetailSessionID()
This returns value of xxx_SCHEDULER_JOB_RUN_DETAILS.SESSION_ID. That value appears to have a format of "xxx,yyy" that consist of two parts. The first part (xxx) represents the session id. The second part (yyy) represents the session serial number.
public java.lang.String getRunDetailSlavePID()
public java.lang.String getRunDetailCpuUsed()
The format is "DDD HH:MM:SS.ss" where DDD is the number of days, HH is the number of hours, MM is the number of minutes, SS.ss is the is the number of seconds (ss is fractional seconds).
public java.lang.String getRunDetailAdditionalInfo()
public java.lang.Long getJobRunInstanceID()
This returns the same value as getRunningJobDBInstance
if the Oracle Scheduler job is running, or getRunDetailInstanceID
if the job has already completed.
public java.lang.String getJobRunInstanceName()
public java.lang.Long getJobRunSessionID()
This returns the same value as getRunningJobSessionID
if the Oracle Scheduler job is running, or the session ID portion of getRunDetailSessionID
if the job has already 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 SQLJobDetail from(javax.management.openmbean.CompositeData cd) throws java.lang.IllegalArgumentException
java.lang.IllegalArgumentException
|
Oracle Fusion Middleware Java API Reference for Oracle Enterprise Scheduler Service 11g Release 1 (11.1.1.6.2) E26229-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |