Package oracle.iam.scheduler.vo
Class JobDetails
java.lang.Object
oracle.iam.scheduler.vo.JobDetails
- All Implemented Interfaces:
Serializable
This value object contains all the information about a Scheduled Job. i.e.
Job Name, Task Name and Corresponding Java class name of the task, Last
Modification date, Retry Count, Job Listener, Parameters, Parameter Types,
Concurrency status TRUE if job is concurrent otherwise FALSE, Job schedule
type, Attributes
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs aJobDetailsobject.JobDetails(String name, Class jobClass, String method, HashMap<String, JobParameter> params, Class[] paramTypes) Constructs aJobDetailsobject.JobDetails(String name, Class jobClass, HashMap<String, JobParameter> attributes) Constructs aJobDetailsobject.JobDetails(ScheduledTask task, String jobName, HashMap<String, JobParameter> params) Constructs aJobDetailsobject. -
Method Summary
Modifier and TypeMethodDescriptionProvides a map containing schedule job parameter name and parameter value object.Provides schedule job's cron schedule types.This method is used to get EmailConfigVo valuesProvides schedule job listener.Provides Schedule job's scheduling type.Provides the last modification date of schedule job.Provides the method name to be called in schedule task implementation class while executing schedule job.getName()Provides Schedule job name.Provides a map containing schedule job parameter name and parameter value object.Class[]Provides Schedule job parameter types.intProvides Schedule job retry count.Provides the schedule task implementation class object.Provides schedule task implementation class name.Provides schedule task key in OIM repository.Provides Schedule task name.booleanProvides concurrency flag.booleanProvides Schedule job status.voidsetAttributes(HashMap<String, JobParameter> params) Sets map containing schedule job parameter name and parameter value object.voidsetConcurrent(boolean concurrent) Sets the concurrency flag TRUE if job is concurrent otherwise FALSEvoidsetConcurrent(String concurrent) Sets the concurrency flag TRUE if job is concurrent otherwise FALSEvoidsetCronScheduleType(String cronScheduleType) Sets schedule job's cron schedule types.voidsetEmailConfig(EmailConfig emailConfig) This method is used to set EmailConfigVOvoidsetJobListener(String jobListener) Sets schedule job listener.voidsetJobScheduleType(String jobScheduleType) Sets Schedule job's scheduling type.voidsetLastModifyDate(Date lastModifyDate) Sets last modification date of schedule job.voidSets method name to be called in schedule task implementation class while executing schedule jobvoidSets schedule job name.voidsetParams(HashMap<String, JobParameter> params) Sets map containing schedule job parameter name and parameter value object.voidsetParamTypes(Class[] paramTypes) Sets Schedule job parameter types.voidsetRetrycount(int retrycount) Sets Schedule job retry count.voidsetRetrycount(Long retrycount) Sets Schedule job retry count.voidsetTaskClass(Class taskClass) Sets schedule task implementation class object.voidsetTaskClass(String taskClass) Sets schedule task implementation class name.voidsetTaskClassName(String taskClassName) Sets schedule task implementation class name.voidsetTaskKey(String taskKey) Sets schedule task key in OIM repository.voidsetTaskName(String jobName) Sets schedule task name.voidsetTaskStatus(boolean taskStatus) Sets Schedule job status.
-
Constructor Details
-
JobDetails
Constructs aJobDetailsobject.- Parameters:
task- Schedule task object containing schedule task information e.g. Schedule task name, task class name, task retry countjobName- Job Nameparams- Map of schedule job parameter name and value object
-
JobDetails
Constructs aJobDetailsobject.- Parameters:
name- Job NamejobClass- Schedule task implementation class objectattributes- Map of schedule job parameter name and value object
-
JobDetails
public JobDetails(String name, Class jobClass, String method, HashMap<String, JobParameter> params, Class[] paramTypes) Constructs aJobDetailsobject.- Parameters:
name- job NamejobClass- Schedule task implementation class namemethod- Method name to be called in schedule task implementation class while executing schedule jobparams- Map of schedule job parameter name and value objectparamTypes- Schedule job parameters types
-
JobDetails
public JobDetails()Constructs aJobDetailsobject.
-
-
Method Details
-
getTaskClass
Provides the schedule task implementation class object.- Returns:
- Schedule task implementation class object
-
getMethod
Provides the method name to be called in schedule task implementation class while executing schedule job.- Returns:
- Method name to be called in schedule task implementation class while executing schedule job
-
getName
Provides Schedule job name.- Returns:
- Schedule job name
-
setConcurrent
public void setConcurrent(boolean concurrent) Sets the concurrency flag TRUE if job is concurrent otherwise FALSE- Parameters:
concurrent- concurrency flag
-
setConcurrent
Sets the concurrency flag TRUE if job is concurrent otherwise FALSE- Parameters:
concurrent- concurrency flag string
-
isConcurrent
public boolean isConcurrent()Provides concurrency flag. TRUE if job is concurrent otherwise FALSE.- Returns:
- concurrency flag
-
getParams
Provides a map containing schedule job parameter name and parameter value object.- Returns:
- Map containing schedule job parameter name and parameter value object
-
getParamTypes
Provides Schedule job parameter types. Supported types are String, Boolean, Number.- Returns:
- Schedule job parameter types
-
getAttributes
Provides a map containing schedule job parameter name and parameter value object.- Returns:
- Map containing schedule job parameter name and parameter value object
-
setName
Sets schedule job name.- Parameters:
name- Schedule job name
-
setTaskClass
Sets schedule task implementation class object.- Parameters:
taskClass- Schedule task implementation class object
-
setTaskClass
Sets schedule task implementation class name.- Parameters:
taskClass- Schedule task implementation class name
-
setMethod
Sets method name to be called in schedule task implementation class while executing schedule job- Parameters:
method- Method name to be called in schedule task implementation class while executing schedule job
-
setParams
Sets map containing schedule job parameter name and parameter value object.- Parameters:
params- Map containing schedule job parameter name and parameter value object
-
setAttributes
Sets map containing schedule job parameter name and parameter value object.- Parameters:
params- map containing schedule job parameter name and parameter value object
-
setParamTypes
Sets Schedule job parameter types. Supported types are String, Boolean, Number.- Parameters:
paramTypes- Schedule job parameter types
-
getTaskClassName
Provides schedule task implementation class name.- Returns:
- Schedule task implementation class name
-
setTaskClassName
Sets schedule task implementation class name.- Parameters:
taskClassName- Schedule task implementation class name
-
getRetrycount
public int getRetrycount()Provides Schedule job retry count.- Returns:
- Schedule job retry count
-
setRetrycount
public void setRetrycount(int retrycount) Sets Schedule job retry count.- Parameters:
retrycount- Schedule job retry count
-
setRetrycount
Sets Schedule job retry count.- Parameters:
retrycount- Schedule job retry count
-
getTaskName
Provides Schedule task name.- Returns:
- Schedule task name
-
setTaskName
Sets schedule task name.- Parameters:
jobName- Schedule task name
-
isTaskStatus
public boolean isTaskStatus()Provides Schedule job status. Job status is TRUE if enabled and FALSE if disabled.- Returns:
- Schedule Job status.
-
setTaskStatus
public void setTaskStatus(boolean taskStatus) Sets Schedule job status. Job status is TRUE if enabled and FALSE if disabled.- Parameters:
taskStatus- Schedule job status
-
getLastModifyDate
Provides the last modification date of schedule job.- Returns:
- Last modification date of schedule job
-
setLastModifyDate
Sets last modification date of schedule job.- Parameters:
lastModifyDate- Last modification date of schedule job
-
getJobListener
Provides schedule job listener.- Returns:
- Schedule job listener
-
setJobListener
Sets schedule job listener.- Parameters:
jobListener- Schedule job listener
-
getTaskKey
Provides schedule task key in OIM repository.- Returns:
- Schedule task key in OIM repository
-
setTaskKey
Sets schedule task key in OIM repository.- Parameters:
taskKey- Schedule task key in OIM repository
-
getJobScheduleType
Provides Schedule job's scheduling type. Supported values are 'None', 'Periodic', 'Cron', 'Single'.- Returns:
- Schedule job's scheduling type
-
setJobScheduleType
Sets Schedule job's scheduling type. Supported values are 'None', 'Periodic', 'Cron', 'Single'.- Parameters:
jobScheduleType- Schedule job's scheduling type
-
getCronScheduleType
Provides schedule job's cron schedule types. Supported values are 'DAILY', 'WEEKLY', 'MONTHLY', 'MONTHLYWEEKDAYS', 'YEARLY'.- Returns:
- Schedule job's cron schedule types
-
setCronScheduleType
Sets schedule job's cron schedule types. Supported values are 'DAILY', 'WEEKLY', 'MONTHLY', 'MONTHLYWEEKDAYS', 'YEARLY'.- Parameters:
cronScheduleType- Schedule job's cron schedule types
-
setEmailConfig
This method is used to set EmailConfigVO- Parameters:
emailConfig-
-
getEmailConfig
This method is used to get EmailConfigVo values- Returns:
-