oracle.iam.scheduler.vo

Class TaskSupport

java.lang.Object

oracle.iam.scheduler.vo.TaskSupport

All Implemented Interfaces:

StoppableTask, oracle.iam.scheduler.vo.Task

Direct Known Subclasses:

com.thortech.xl.scheduler.tasks.SchedulerBaseTask

public abstract class TaskSupport
extends java.lang.Object
implements StoppableTask

This is a base class for each schedule task implementation class.

Constructor Summary

Constructors

Constructor and Description
TaskSupport()

Method Summary

Modifier and Type	Method and Description
void	addCustomParams(java.lang.String key, java.io.Serializable value) Add a new custom param to the existing custom parameters map.
void	addJobResults(java.util.List jobResults) Add the results of the job in bulk.
void	addResult(JobResult result) Appends a particular JobResult to the jobResults list.
BulkNotificationEvent	createNotificationEvent(java.lang.Double failedJobID, java.lang.String execeptionMessage, java.lang.String jobName, java.lang.String jobStartDate) This Method is used to create a Notification event using following arguments
void	executeJob(java.util.HashMap attributes)
java.lang.String	getId()
java.lang.String	getImplementation()
java.lang.Double	getJobID()
java.lang.String	getName()
java.lang.String	getTaskName()
boolean	isJobSuccess()
boolean	isStop() Provides a flag indicating whether a schedule job is stopped or not.
void	sendNotification(java.lang.Double failedJobID, java.lang.String execeptionMessage, java.lang.String jobName, java.lang.String jobStartDate) method to generate notification event
void	setCustomParams(java.util.HashMap customParams) Set the custom parameters for the job.
void	setCustomStatus(java.lang.String customStatus) Set the custom status for the job.
void	setEmailConfig(EmailConfig emailConfig) Sets the email config
void	setImplementation(java.lang.String implementation)
void	setName(java.lang.String name)
void	setTaskName(java.lang.String taskName)
boolean	stop() This method is used to stop a schedule task.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.iam.scheduler.vo.Task

execute, getAttributes, setAttributes

Constructor Detail

TaskSupport

public TaskSupport()

Method Detail

getJobID

public java.lang.Double getJobID()

setCustomParams

public void setCustomParams(java.util.HashMap customParams)

Set the custom parameters for the job. The final map will be set at the end of the job.

Parameters:

customParams - HashMap of the custom parameters for the job

addCustomParams

public void addCustomParams(java.lang.String key,
                            java.io.Serializable value)

Add a new custom param to the existing custom parameters map.

Parameters:

key - Name of the custom param

value - Value of the custom param

setCustomStatus

public void setCustomStatus(java.lang.String customStatus)

Set the custom status for the job.

Parameters:

customStatus - The custom status to be set

setEmailConfig

public void setEmailConfig(EmailConfig emailConfig)

Sets the email config

Specified by:

setEmailConfig in interface oracle.iam.scheduler.vo.Task

Parameters:

emailConfig -

addJobResults

public void addJobResults(java.util.List jobResults)

Add the results of the job in bulk.

Parameters:

jobResults - List of JobResult

addResult

public void addResult(JobResult result)

Appends a particular JobResult to the jobResults list.

Parameters:

result - The JobResult to be added to the jobResults list

isJobSuccess

public boolean isJobSuccess()

Specified by:

isJobSuccess in interface oracle.iam.scheduler.vo.Task

getTaskName

public java.lang.String getTaskName()

Specified by:

getTaskName in interface oracle.iam.scheduler.vo.Task

setTaskName

public void setTaskName(java.lang.String taskName)

Specified by:

setTaskName in interface oracle.iam.scheduler.vo.Task

getName

public java.lang.String getName()

Specified by:

getName in interface oracle.iam.scheduler.vo.Task

getImplementation

public java.lang.String getImplementation()

Specified by:

getImplementation in interface oracle.iam.scheduler.vo.Task

setName

public void setName(java.lang.String name)

Specified by:

setName in interface oracle.iam.scheduler.vo.Task

setImplementation

public void setImplementation(java.lang.String implementation)

Specified by:

setImplementation in interface oracle.iam.scheduler.vo.Task

stop

public boolean stop()

Description copied from interface: StoppableTask

This method is used to stop a schedule task. if schedule task is stopped without any error than return TRUE else FALSE.

Specified by:

stop in interface StoppableTask

Returns:

TRUE if schedule task is stopped otherwise FALSE

isStop

public boolean isStop()

Provides a flag indicating whether a schedule job is stopped or not. 'TRUE' if job is stopped otherwise 'FALSE'.

Returns:

Flag indicating whether a schedule job is stopped or not.

getId

public java.lang.String getId()

Specified by:

getId in interface oracle.iam.scheduler.vo.Task

executeJob

public final void executeJob(java.util.HashMap attributes)
                      throws java.lang.Exception

Specified by:

executeJob in interface oracle.iam.scheduler.vo.Task

Throws:

java.lang.Exception

sendNotification

public void sendNotification(java.lang.Double failedJobID,
                             java.lang.String execeptionMessage,
                             java.lang.String jobName,
                             java.lang.String jobStartDate)

method to generate notification event

Parameters:

failedJobID - id of failed job exceptionMessage To provide exception cause jobName name of failed schedule job jobStartDate date of failed job creation

createNotificationEvent

public BulkNotificationEvent createNotificationEvent(java.lang.Double failedJobID,
                                                     java.lang.String execeptionMessage,
                                                     java.lang.String jobName,
                                                     java.lang.String jobStartDate)

This Method is used to create a Notification event using following arguments

Parameters:

failedJobID - id of failed job

execeptionMessage - To provide exception cause

jobName - name of failed schedule job

jobStartDate - start time of job

Returns:

instance of BulkNotificationEvent