oracle.iam.scheduler.api

Interface SchedulerService

All Known Subinterfaces:

SchedulerServiceInternal

public interface SchedulerService

Method Summary

Modifier and Type	Method and Description
void	addJob(JobDetails job) Adds the job that would be scheduled using the Scheduler Service
void	createScheduledTask(org.w3c.dom.Document xmlDoc) Create a Schedule task definition in the metadata repository.
void	createScheduledTask(ScheduledTask scheduleTask) Create a Schedule task definition in the metadata repository.
void	deleteJob(JobDetails job) Deletes the specified Job that has been registered with the Scheduler Service
JobDetails[]	deleteScheduledTask(java.lang.String scheduleTaskName) Delete the Schedule task definition from the metadata repository.
void	deleteTrigger(java.lang.String jobName) Deletes the specified trigger that has been registered with a Job
JobHistoryBulk	getAllHistory(java.sql.Timestamp begin, java.sql.Timestamp end, java.lang.String[] statuses, java.lang.String jobName, int offset, int limit, java.lang.String sortBy, boolean isAscending) This method will return the global execution history within a time period
java.util.List	getAllHistoryOfJob() Returns a run history of all the Jobs in the system
JobDetails[]	getAllJobDetails() Returns a list of Job-details for all the Jobs in the system
java.lang.String[]	getAllJobs() Returns a list of name of all the Scheduler Jobs
JobHistory	getHistoryOfJob(long jobHistoryID) Returns the details of the jobHitory for the jobHistoryID passed as a parameter
java.util.List	getHistoryOfJob(java.lang.String jobName) Lists the detail of the runs made for the specified schedule Job
HistorySummary	getHistorySummary(java.sql.Timestamp begin, java.sql.Timestamp end) This method will return a summary consisting of the count of failed, interrupted and running jobs with given date range
JobDetails	getJobDetail(java.lang.String jobName) Returns the JobDetail for the specified job
JobDetails[]	getJobDetails(java.lang.String searchCriteria) Searches the jobs with the specified search criteria.Wild card characters can be specified as the search criteria
JobHistoryBulk	getJobHistoryPaginated(java.lang.String jobName, int offset, int limit, java.lang.String sortBy, boolean isAscending)
JobParameter	getJobParameter(long id, java.lang.String parameterType) Deprecated.
JobParameter	getJobParameter(java.lang.String name, java.lang.String parameterType) Deprecated.
java.util.HashMap	getJobParameters(java.lang.String searchCriteria, java.lang.String parameterType) Deprecated.
java.util.List	getJobResults(java.lang.Double jobHistoryID) Retrieves the list of jobResults for the specified jobHistoryId
java.lang.String[]	getJobs(java.lang.String jobName) Searches the job with the specified name.Wild card characters can be specified as the search criteria
JobDetails[]	getJobsOfSchedulerTask(java.lang.String scheduleTaskName) Returns a list of the Job Details for all the jobs for the specified Task
JobHistory	getLastHistoryOfJob(java.lang.String jobName) Returns the details of the last job run for the Job specified
java.lang.String[]	getScheduledTasks(java.lang.String searchCriteria) Returns a list of Schedule Tasks which match the search criteria provided
int	getStatus() Returns the Scheduler Service Status
int	getStatusOfJob(java.lang.String jobName)
Trigger[]	getTriggersOfJob(java.lang.String jobName) It returns all the triggers attached to a schedule Job.
java.util.HashMap	listScheduledTasks() Returns a list of all the schedule tasks
ScheduledTask	lookupScheduledTask(java.lang.String scheduleTaskName) Finds the Task that is specified as parameter
ScheduledTask[]	lookupScheduledTaskbyClass(java.lang.String scheduleTaskClassName) Finds the Task that is specified as parameter
void	pauseJob(java.lang.String jobName) Pauses the action of the specified schedule Job
void	pauseTrigger(java.lang.String triggerName) Deprecated.
void	rescheduleJob(java.lang.String jobName, java.lang.String existingTriggerName, Trigger trigger) Updates the trigger attached with the job
void	resetRunningJobStatus() This method is invoked after invocation of shut down of scheduler service/shutdown of server This method reset the status of all the running jobs to stopped in job history table
void	resumeJob(java.lang.String jobName) Resumes the action of the paused schedule Job
void	scheduleJob(JobDetails job, Trigger trigger) Schedules the specified job as per the trigger details provided
void	scheduleJob(java.lang.String jobName, Trigger trigger) Schedules the specified job as per the trigger details provided
java.util.HashMap	searchJobs(SearchCriteria searchCriteria) Retrieves list of schedule Jobs based on the search criteria For specifying searchcriteria use JOB_NAME_FILTER, TASK_FILTER and JOB_STATUS_FILTER as parameters only.
void	start() Starts the Scheduler Service
void	stop() Stops the Scheduler Service
void	stopJob(java.lang.String jobName) Stops the instance of the Job that is running
void	triggerNow(java.lang.String jobName) Runs the specified job
void	triggerNow(java.lang.String jobName, NowTrigger trigger) Deprecated.
void	updateJob(JobDetails job) Updates the schedule Job that has been created.The update can either be for the job details or the job parameters.
void	updateScheduledTask(org.w3c.dom.Document xmlDoc) Update a Schedule task definition in the metadata repository.
void	updateScheduledTask(ScheduledTask scheduleTask) Update a Schedule task definition in the metadata repository.

Method Detail

start

void start()
    throws SchedulerException,
           SchedulerAccessDeniedException

Starts the Scheduler Service

Throws:

SchedulerException

SchedulerAccessDeniedException

scheduleJob

void scheduleJob(JobDetails job,
                 Trigger trigger)
          throws SchedulerException,
                 RequiredParameterNotSetException,
                 ParameterValueTypeNotSupportedException,
                 IncorrectScheduleTaskDefinationException,
                 SchedulerAccessDeniedException

Schedules the specified job as per the trigger details provided

Parameters:

Job - Detail of the job that is to be scheduled

trigger - Trigger Details to specify when the scheduled job will be triggered

Throws:

SchedulerException - is thrown when Job Parameters are not of one of the expected Data-Types

RequiredParameterNotSetException - This exception will be thrown if value is not set for required parameters of a schedule Job.

ParameterValueTypeNotSupported - Exception This exception will be thrown if value set for required parameters of a schedule Job is not supported in application. Only following type is supported String, Boolean & Long

IncorrectScheduleTaskDefination - Exception This exception will be thrown if SchedulerTask definition is not correct

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

ParameterValueTypeNotSupportedException

IncorrectScheduleTaskDefinationException

scheduleJob

void scheduleJob(java.lang.String jobName,
                 Trigger trigger)
          throws SchedulerException,
                 oracle.iam.platform.kernel.StaleDataException,
                 SchedulerAccessDeniedException

Schedules the specified job as per the trigger details provided

Parameters:

jobName - Name of the job that is to be scheduled

trigger - Trigger Details to specify when the scheduled job will be triggered

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

oracle.iam.platform.kernel.StaleDataException - This exception will be thrown if data is already updated

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

deleteJob

void deleteJob(JobDetails job)
        throws SchedulerException,
               LastModifyDateNotSetException,
               oracle.iam.platform.kernel.StaleDataException,
               SchedulerAccessDeniedException,
               SchedulerJobNotDeletableException

Deletes the specified Job that has been registered with the Scheduler Service

Parameters:

job - JobDetails of the job that is to be deleted.

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

oracle.iam.platform.kernel.StaleDataException - This exception will be thrown if data is already updated

LastModifyDateNotSetException - This exception will be thrown if last modify date is not set for the object.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

SchedulerJobNotDeletableException - This exception will be thrown if Schedule Job cannot be deleted because it is running.

deleteTrigger

void deleteTrigger(java.lang.String jobName)
            throws SchedulerException,
                   SchedulerAccessDeniedException

Deletes the specified trigger that has been registered with a Job

Parameters:

jobName - name of job whose trigger has to be delete

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

addJob

void addJob(JobDetails job)
     throws SchedulerException,
            RequiredParameterNotSetException,
            ParameterValueTypeNotSupportedException,
            IncorrectScheduleTaskDefinationException,
            SchedulerAccessDeniedException

Adds the job that would be scheduled using the Scheduler Service

Parameters:

job - Details of the job that is to be added.

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

RequiredParameterNotSetException - This exception will be thrown if value is not set for required parameters of a schedule job.

ParameterValueTypeNotSupportedException - This exception will be thrown if value set for required parameters of a schedule job is not supported in application. Only following type is supported String, Boolean & Long

IncorrectScheduleTaskDefinationException - This exception will be thrown if SchedulerTask definition is not correct

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

updateJob

void updateJob(JobDetails job)
        throws SchedulerException,
               RequiredParameterNotSetException,
               ParameterValueTypeNotSupportedException,
               IncorrectScheduleTaskDefinationException,
               oracle.iam.platform.kernel.StaleDataException,
               LastModifyDateNotSetException,
               SchedulerAccessDeniedException

Updates the schedule Job that has been created.The update can either be for the job details or the job parameters.

Parameters:

job - JobDetails of the job (and or job parameters ) that is to be updated

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

RequiredParameterNotSetException - This exception will be thrown if value is not set for required parameters of a schedule Job.

ParameterValueTypeNotSupportedException - This exception will be thrown if value set for required parameters of a schedule Job is not supported in application. Only following type is supported String, Boolean & Long

IncorrectScheduleTaskDefinationException - This exception will be thrown if SchedulerTask definition is not correct

oracle.iam.platform.kernel.StaleDataException - This exception will be thrown if data is already updated

LastModifyDateNotSetException - This exception will be thrown if last modify date is not set for the object.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

triggerNow

void triggerNow(java.lang.String jobName)
         throws SchedulerException,
                SchedulerAccessDeniedException

Runs the specified job

Parameters:

jobName - The job that is to be triggered

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

triggerNow

void triggerNow(java.lang.String jobName,
                NowTrigger trigger)
         throws SchedulerException,
                SchedulerAccessDeniedException

Deprecated.

Runs the specified job at the specified time

Parameters:

jobName - The job that is to be triggered

trigger - Trigger details for the execution of the specified job

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - SchedulerAccessDeniedException This exception will be thrown if access permission for operation is not available to the user

stopJob

void stopJob(java.lang.String jobName)
      throws SchedulerException,
             SchedulerAccessDeniedException

Stops the instance of the Job that is running

Parameters:

jobName - name of the schedule Job

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

getTriggersOfJob

Trigger[] getTriggersOfJob(java.lang.String jobName)
                    throws SchedulerException

It returns all the triggers attached to a schedule Job.

Parameters:

jobName - name of the schedule Job

Returns:

The array of triggers attached with the specified Job

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

rescheduleJob

void rescheduleJob(java.lang.String jobName,
                   java.lang.String existingTriggerName,
                   Trigger trigger)
            throws SchedulerException,
                   LastModifyDateNotSetException,
                   oracle.iam.platform.kernel.StaleDataException,
                   SchedulerAccessDeniedException

Updates the trigger attached with the job

Parameters:

jobName - name of the schedule Job

existingTriggerName - OLD Trigger Name that is to be replaced

trigger - New Trigger Details, set the lastModifyDate with the Date on which you are going to update

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

oracle.iam.platform.kernel.StaleDataException - This exception will be thrown if data is already updated

LastModifyDateNotSetException - This exception will be thrown if last modify date is not set for the object.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

getJobDetail

JobDetails getJobDetail(java.lang.String jobName)
                 throws SchedulerException

Returns the JobDetail for the specified job

Parameters:

jobName - name of the schedule Job

Returns:

Detail of the job which is specified as a parameter

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

stop

void stop()
   throws SchedulerException,
          SchedulerAccessDeniedException

Stops the Scheduler Service

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

lookupScheduledTask

ScheduledTask lookupScheduledTask(java.lang.String scheduleTaskName)
                           throws IncorrectScheduleTaskDefinationException

Finds the Task that is specified as parameter

Parameters:

scheduleTaskName - name of the schedule task whose details are to be fetched

Returns:

The details of the task along with the Schedule task parameters for the task name passed as parameter

Throws:

IncorrectScheduleTaskDefinationException - This exception will be thrown if SchedulerTask definition is not correct

lookupScheduledTaskbyClass

ScheduledTask[] lookupScheduledTaskbyClass(java.lang.String scheduleTaskClassName)
                                    throws IncorrectScheduleTaskDefinationException

Finds the Task that is specified as parameter

Parameters:

scheduleTaskClassName - name of the schedule task class whose details are to be fetched

Returns:

The array of details of the task along with the Schedule task parameters for the task class name passed

Throws:

IncorrectScheduleTaskDefinationException - This exception will be thrown if SchedulerTask definition is not correct

deleteScheduledTask

JobDetails[] deleteScheduledTask(java.lang.String scheduleTaskName)
                          throws SchedulerException,
                                 DeleteScheduleTaskDefinitionException,
                                 SchedulerAccessDeniedException,
                                 LastModifyDateNotSetException,
                                 oracle.iam.platform.kernel.StaleDataException,
                                 SchedulerJobNotDeletableException

Delete the Schedule task definition from the metadata repository. Before deleting the Schedule task definition, need to stop all the running jobs related to this schedule task and delete the same.

Parameters:

scheduleTaskName - name of the schedule task to be deleted

Returns:

if the schedule task exists in MDS for the given name, than returns List of the Job Details for all the jobs deleted against this schedule task. else returns null.

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

DeleteScheduleTaskDefinationException - This exception will be thrown if MetaData repository throw any exception while deleting a Schedule task from MDS.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user.

LastModifyDateNotSetException - This exception will be thrown if last modify date is not set for the object.

oracle.iam.platform.kernel.StaleDataException - This exception will be thrown if data is already updated

SchedulerJobNotDeletableException - This exception will be thrown if Schedule Job cannot be deleted because it is running.

DeleteScheduleTaskDefinitionException

updateScheduledTask

void updateScheduledTask(org.w3c.dom.Document xmlDoc)
                  throws SchedulerException,
                         SchedulerAccessDeniedException,
                         CreateScheduleTaskDefinitionException,
                         UpdateScheduleTaskDefinitionException,
                         IncorrectScheduleTaskDefinationException

Update a Schedule task definition in the metadata repository. Before updating a Schedule task definition, need to check metadata repository for schedule task with given name.

Parameters:

xmlDoc - of the XML contains schedule task definition to be created

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user.

IncorrectScheduleTaskDefinationException - This exception will be thrown if schedule task definition is incorrect.

UpdateScheduleTaskDefinitionException - This exception is thrown if any exception thrown from MDS repository while creating a schedule task.

CreateScheduleTaskDefinitionException

Since:

11.1.1.6.0

updateScheduledTask

void updateScheduledTask(ScheduledTask scheduleTask)
                  throws SchedulerException,
                         SchedulerAccessDeniedException,
                         CreateScheduleTaskDefinitionException,
                         UpdateScheduleTaskDefinitionException,
                         IncorrectScheduleTaskDefinationException

Update a Schedule task definition in the metadata repository. Before creating a Schedule task definition, need to check metadata repository for schedule task with given name.

Parameters:

scheduleTask - is value object defined for scheduled task.

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user.

IncorrectScheduleTaskDefinationException - This exception will be thrown if schedule task defination is incorrect.

UpdateScheduleTaskDefinitionException - This exception is thrown if any exception thrown from MDS repository while creating a schedule task.

CreateScheduleTaskDefinitionException

Since:

11.1.1.6.0

createScheduledTask

void createScheduledTask(org.w3c.dom.Document xmlDoc)
                  throws SchedulerException,
                         SchedulerAccessDeniedException,
                         CreateScheduleTaskDefinitionException,
                         IncorrectScheduleTaskDefinationException

Create a Schedule task definition in the metadata repository. Before creating a Schedule task definition, need to check metadata repository for schedule task with given name.

Parameters:

xmlDoc - of the XML contains schedule task definition to be created

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user.

IncorrectScheduleTaskDefinationException - This exception will be thrown if schedule task definition is incorrect.

CreateScheduleTaskDefinitionException - This exception is thrown if any exception thrown from MDS repository while creating a schedule task.

Since:

11.1.1.6.0

createScheduledTask

void createScheduledTask(ScheduledTask scheduleTask)
                  throws SchedulerException,
                         SchedulerAccessDeniedException,
                         CreateScheduleTaskDefinitionException,
                         IncorrectScheduleTaskDefinationException

Create a Schedule task definition in the metadata repository. Before creating a Schedule task definition, need to check matadata repository for schedule task with given name.

Parameters:

scheduleTask - is value object defined for scheduled task.

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user.

IncorrectScheduleTaskDefinationException - This exception will be thrown if schedule task defination is incorrect.

CreateScheduleTaskDefinitionException - This exception is thrown if any exception thrown from MDS repository while creating a schedule task.

Since:

11.1.1.6.0

listScheduledTasks

java.util.HashMap listScheduledTasks()
                              throws IncorrectScheduleTaskDefinationException

Returns a list of all the schedule tasks

Returns:

HashMap of all the schedule tasks

Throws:

IncorrectScheduleTaskDefinationException - This exception will be thrown if SchedulerTask definition is not correct

getAllJobs

java.lang.String[] getAllJobs()
                       throws SchedulerException

Returns a list of name of all the Scheduler Jobs

Returns:

list of name of all the Scheduler Jobs

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

getJobs

java.lang.String[] getJobs(java.lang.String jobName)
                    throws SchedulerException

Searches the job with the specified name.Wild card characters can be specified as the search criteria

Parameters:

jobName - name of the job that is to be searched

Returns:

A list of jobs that meet the search criteria

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

getJobDetails

JobDetails[] getJobDetails(java.lang.String searchCriteria)
                    throws SchedulerException

Searches the jobs with the specified search criteria.Wild card characters can be specified as the search criteria

Parameters:

searchCriteria - criteria of the job that is to be searched

Returns:

a array of Job Details value object.

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

getScheduledTasks

java.lang.String[] getScheduledTasks(java.lang.String searchCriteria)
                              throws IncorrectScheduleTaskDefinationException

Returns a list of Schedule Tasks which match the search criteria provided

Parameters:

searchCriteria - criteria using which schedule tasks are to be searched

Returns:

List of Schedule Tasks that meet the search criteria

Throws:

IncorrectScheduleTaskDefinationException - This exception will be thrown if SchedulerTask definition is not correct

getStatusOfJob

int getStatusOfJob(java.lang.String jobName)
            throws SchedulerException

Parameters:

JobName - whose status is to be fetched

Returns:

The integer value that maps to a status of the Scheduled Job '2' correspond to 'STOPPED', '5' correspond to 'RUNNING', '6' correspond to 'FAILED', '7' correspond to 'INTERRUPT'

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

getHistoryOfJob

java.util.List getHistoryOfJob(java.lang.String jobName)

Lists the detail of the runs made for the specified schedule Job

Parameters:

jobName - name of the Schedule Job whose RUN-history is to be fetched

Returns:

List of runs made for the specified Job

getAllHistoryOfJob

java.util.List getAllHistoryOfJob()

Returns a run history of all the Jobs in the system

Returns:

List of JobHistory for all the Jobs in the system

getLastHistoryOfJob

JobHistory getLastHistoryOfJob(java.lang.String jobName)
                        throws NoJobHistoryFoundException

Returns the details of the last job run for the Job specified

Parameters:

jobName - name of the schedule Job whose history is to be retrieved

Returns:

JobHistory

Throws:

NoJobHistoryFoundException - when no history is available for the Job

getHistoryOfJob

JobHistory getHistoryOfJob(long jobHistoryID)
                    throws NoJobHistoryFoundException

Returns the details of the jobHitory for the jobHistoryID passed as a parameter

Parameters:

jobHistoryID - Id for which the details have to be fetched

Returns:

JobHistory

Throws:

NoJobHistoryFoundException

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

resumeJob

void resumeJob(java.lang.String jobName)
        throws SchedulerException,
               SchedulerAccessDeniedException

Resumes the action of the paused schedule Job

Parameters:

jobName - name of the schedule Job

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

pauseJob

void pauseJob(java.lang.String jobName)
       throws SchedulerException,
              SchedulerAccessDeniedException

Pauses the action of the specified schedule Job

Parameters:

jobName - name of the schedule Job

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

SchedulerAccessDeniedException - This exception will be thrown if access permission for operation is not available to the user

getJobsOfSchedulerTask

JobDetails[] getJobsOfSchedulerTask(java.lang.String scheduleTaskName)
                             throws SchedulerException

Returns a list of the Job Details for all the jobs for the specified Task

Parameters:

scheduleTaskName - name of the schedule task

Returns:

array of the Job Details for all the jobs for the specified task

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

getStatus

int getStatus()

Returns the Scheduler Service Status

Returns:

The integer value that maps to a status of the Scheduler '0' correspond to 'SHUTDOWN', '1' correspond to 'STARTED', '2' correspond to 'STOPPED'

getAllJobDetails

JobDetails[] getAllJobDetails()
                       throws SchedulerException

Returns a list of Job-details for all the Jobs in the system

Returns:

A array of JobDetail object for all the Jobs present in the system

Throws:

SchedulerException - when an error occurs at the Quartz Engine or scheduler is not running.

getJobParameters

java.util.HashMap getJobParameters(java.lang.String searchCriteria,
                                   java.lang.String parameterType)

Deprecated.

Returns a HashMap of key and name of the Job Parameters

Parameters:

searchCriteria - . This API allows passing wildcard, type of IT Resource type values etc as search criteria.

parameterType - type of parameter for e.g ITResource If a * is passed as SearchCriteria, API returns all the instances in the system.

Returns:

A HashMap for all the ITResources present in the system

getJobParameter

JobParameter getJobParameter(long id,
                             java.lang.String parameterType)
                      throws JobParameterNotFoundException

Deprecated.

Returns the Resource Object with the whose ID specified in the parameter

Parameters:

id - of Resource

parameterType - type of parameter

Returns:

ITResource object of IT Resource

Throws:

JobParameterNotFoundException - if no IT Resource found against the lookup criteria

getJobParameter

JobParameter getJobParameter(java.lang.String name,
                             java.lang.String parameterType)
                      throws JobParameterNotFoundException

Deprecated.

Returns the Resource Object with the name specified in the parameter

Parameters:

name - of the JobParameter value

parameterType - type of parameter

Returns:

JobParameter object of JobParameter.

Throws:

JobParameterNotFoundException - if no IT Resource found against the lookup criteria

pauseTrigger

void pauseTrigger(java.lang.String triggerName)
           throws SchedulerException,
                  SchedulerAccessDeniedException

Deprecated.

Pauses the action of the running schedule task

Parameters:

triggerName - Name of the Trigger

Throws:

SchedulerException

SchedulerAccessDeniedException

searchJobs

java.util.HashMap searchJobs(SearchCriteria searchCriteria)
                      throws SchedulerException,
                             SchedulerAccessDeniedException

Retrieves list of schedule Jobs based on the search criteria For specifying searchcriteria use JOB_NAME_FILTER, TASK_FILTER and JOB_STATUS_FILTER as parameters only. By default, the results will be sorted based on id column. Calls can be made in the following manner SearchCriteria sc1 = new SearchCriteria("JOB_NAME_FILTER", jobname, SearchCriteria.Operator.EQUAL); SearchCriteria sc2 = new SearchCriteria("TASK_FILTER", taskname, SearchCriteria.Operator.EQUAL); SearchCriteria sc3 = new SearchCriteria("JOB_STATUS_FILTER", status, SearchCriteria.Operator.EQUAL); SearchCriteria sc4 = new SearchCriteria(sc1, sc2, SearchCriteria.Operator.AND); SearchCriteria sc5 = new SearchCriteria(sc4, sc3, SearchCriteria.Operator.AND); long start=1, end=4; List list = schedulerService.searchTemplate(sc5, start, end);

Returns:

A list of matching Jobs

Throws:

SchedulerException

SchedulerAccessDeniedException - Access related exception

resetRunningJobStatus

void resetRunningJobStatus()
                    throws SchedulerException,
                           SchedulerAccessDeniedException

This method is invoked after invocation of shut down of scheduler service/shutdown of server This method reset the status of all the running jobs to stopped in job history table

Throws:

SchedulerException

SchedulerAccessDeniedException

getHistorySummary

HistorySummary getHistorySummary(java.sql.Timestamp begin,
                                 java.sql.Timestamp end)
                          throws SchedulerException

This method will return a summary consisting of the count of failed, interrupted and running jobs with given date range

Parameters:

begin -

end -

Returns:

Throws:

SchedulerException

getAllHistory

JobHistoryBulk getAllHistory(java.sql.Timestamp begin,
                             java.sql.Timestamp end,
                             java.lang.String[] statuses,
                             java.lang.String jobName,
                             int offset,
                             int limit,
                             java.lang.String sortBy,
                             boolean isAscending)
                      throws SchedulerException

This method will return the global execution history within a time period

Parameters:

begin - start date of time period

end - end date of time period

statuses - filter by job status

jobName - filter by job name

offset -

limit -

sortBy -

isAscending -

Returns:

Throws:

SchedulerException

getJobHistoryPaginated

JobHistoryBulk getJobHistoryPaginated(java.lang.String jobName,
                                      int offset,
                                      int limit,
                                      java.lang.String sortBy,
                                      boolean isAscending)
                               throws SchedulerException

Throws:

SchedulerException