oracle.iam.scheduler.api

Interface SchedulerServiceInternal

All Superinterfaces:

SchedulerService

public interface SchedulerServiceInternal
extends SchedulerService

Service interface to query and manage job history and job results .

Method Summary

Modifier and Type	Method and Description
JobHistory	addJobHistory(JobHistory jobHistory) Save the details for a particular run of a job in the job history table.
void	addJobResults(java.lang.Double jobHistoryID, java.util.List jobResults) This method is invoked after scheduled job run to record the results for the run.
JobHistory	getJobHistory(long jobHistoryId) Retrieves the history for a job for the specified jobHistoryId.
JobResult	getJobResult(long jobResultID) Retrieves a particular job results
java.util.List	getJobResults(java.lang.Double jobHistoryID) Retrieves the list of jobResults for the specified jobHistoryId
java.util.List	getJobResults(long jobHistoryID, int lowerBound, int pazeSize, boolean ascendingOrder) This is the paginated search API for the JobResults.
JobHistory	updateJobHistory(JobHistory jobHistory) Update the details in the job history table for a particular run of the job
void	updateJobWithFailCount(JobDetails job, int failCount) Update job with fail count.

Methods inherited from interface oracle.iam.scheduler.api.SchedulerService

addJob, createScheduledTask, createScheduledTask, deleteJob, deleteScheduledTask, deleteTrigger, getAllHistoryOfJob, getAllJobDetails, getAllJobs, getHistoryOfJob, getHistoryOfJob, getJobDetail, getJobDetails, getJobParameter, getJobParameter, getJobParameters, getJobs, getJobsOfSchedulerTask, getLastHistoryOfJob, getScheduledTasks, getStatus, getStatusOfJob, getTriggersOfJob, listScheduledTasks, lookupScheduledTask, lookupScheduledTaskbyClass, pauseJob, pauseTrigger, rescheduleJob, resetRunningJobStatus, resumeJob, scheduleJob, scheduleJob, searchJobs, start, stop, stopJob, triggerNow, triggerNow, updateJob, updateScheduledTask, updateScheduledTask

Method Detail

updateJobWithFailCount

void updateJobWithFailCount(JobDetails job,
                            int failCount)
                     throws SchedulerException,
                            oracle.iam.platform.kernel.StaleDataException

Update job with fail count.

Parameters:

job - Job VO

failCount - failcount which needs to be updated here.

Throws:

SchedulerException

oracle.iam.platform.kernel.StaleDataException

Since:

11.1.2.1.0

addJobHistory

JobHistory addJobHistory(JobHistory jobHistory)
                  throws SchedulerException

Save the details for a particular run of a job in the job history table.

Parameters:

jobHistory - JobHistory VO

Returns:

Update JobHistory VO.

Throws:

SchedulerException

updateJobHistory

JobHistory updateJobHistory(JobHistory jobHistory)
                     throws SchedulerException

Update the details in the job history table for a particular run of the job

Parameters:

jobHistory - JobHistory VO. The id is used for seraching.

Returns:

Update JobHistory VO

Throws:

SchedulerException

getJobHistory

JobHistory getJobHistory(long jobHistoryId)
                  throws SchedulerException

Retrieves the history for a job for the specified jobHistoryId. This doesn't retrieve the jobResults for this. Use SchedulerServiceInternal.getJobResults(Double)

Parameters:

jobHistoryId - The id of the particular job run in the jobHistory table.

Returns:

JobHistory VO

Throws:

SchedulerException

addJobResults

void addJobResults(java.lang.Double jobHistoryID,
                   java.util.List jobResults)
            throws SchedulerException

This method is invoked after scheduled job run to record the results for the run. This updates the results for the job run in the job result table.

Parameters:

jobHistoryID - The id of the particular job run in the jobHistory table.

jobResults - List of the JobResults.

Throws:

SchedulerException

getJobResults

java.util.List getJobResults(java.lang.Double jobHistoryID)
                      throws SchedulerException

Retrieves the list of jobResults for the specified jobHistoryId

Parameters:

jobHistoryID - The ID of the job run for which the results are required.

Returns:

List of the JobResults.

Throws:

SchedulerException

getJobResults

java.util.List getJobResults(long jobHistoryID,
                             int lowerBound,
                             int pazeSize,
                             boolean ascendingOrder)
                      throws SchedulerException

This is the paginated search API for the JobResults.

Parameters:

jobHitoryID - The ID of the job run for which the results are required.

lowerBound - The lower bound of the results to be displayed.

pazeSize - The total no. of records to be displayed.

ascendingOrder - Sorting order, based on ID.

Returns:

List of the JobResults

Throws:

SchedulerException

getJobResult

JobResult getJobResult(long jobResultID)
                throws SchedulerException

Retrieves a particular job results

Parameters:

jobResultID - The ID of the jobResult to be displayed.

Returns:

JobResult VO

Throws:

SchedulerException