Skip navigation links


oracle.iam.scheduler.vo
Class JobDetails

java.lang.Object
  extended by oracle.iam.scheduler.vo.JobDetails

All Implemented Interfaces:
java.io.Serializable

public class JobDetails
extends java.lang.Object
implements java.io.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:
Serialized Form

Constructor Summary
JobDetails()
          Constructs a JobDetails object.
JobDetails(ScheduledTask task, java.lang.String jobName, java.util.HashMap params)
          Constructs a JobDetails object.
JobDetails(java.lang.String name, java.lang.Class jobClass, java.util.HashMap attributes)
          Constructs a JobDetails object.
JobDetails(java.lang.String name, java.lang.Class jobClass, java.lang.String method, java.util.HashMap params, java.lang.Class[] paramTypes)
          Constructs a JobDetails object.

 

Method Summary
 java.util.HashMap getAttributes()
          Provides a map containing schedule job parameter name and parameter value object.
 java.lang.String getCronScheduleType()
          Provides schedule job's cron schedule types.
 java.lang.String getJobListener()
          Provides schedule job listener.
 java.lang.String getJobScheduleType()
          Provides Schedule job's scheduling type.
 java.util.Date getLastModifyDate()
          Provides the last modification date of schedule job.
 java.lang.String getMethod()
          Provides the method name to be called in schedule task implementation class while executing schedule job.
 java.lang.String getName()
          Provides Schedule job name.
 java.util.HashMap getParams()
          Provides a map containing schedule job parameter name and parameter value object.
 java.lang.Class[] getParamTypes()
          Provides Schedule job parameter types.
 int getRetrycount()
          Provides Schedule job retry count.
 java.lang.Class getTaskClass()
          Provides the schedule task implementation class object.
 java.lang.String getTaskClassName()
          Provides schedule task implementation class name.
 java.lang.String getTaskKey()
          Provides schedule task key in OIM repository.
 java.lang.String getTaskName()
          Provides Schedule task name.
 boolean isConcurrent()
          Provides concurrency flag.
 boolean isTaskStatus()
          Provides Schedule job status.
 void setAttributes(java.util.HashMap params)
          Sets map containing schedule job parameter name and parameter value object.
 void setConcurrent(boolean concurrent)
          Sets the concurrency flag TRUE if job is concurrent otherwise FALSE
 void setConcurrent(java.lang.String concurrent)
          Sets the concurrency flag TRUE if job is concurrent otherwise FALSE
 void setCronScheduleType(java.lang.String cronScheduleType)
          Sets schedule job's cron schedule types.
 void setJobListener(java.lang.String jobListener)
          Sets schedule job listener.
 void setJobScheduleType(java.lang.String jobScheduleType)
          Sets Schedule job's scheduling type.
 void setLastModifyDate(java.util.Date lastModifyDate)
          Sets last modification date of schedule job.
 void setMethod(java.lang.String method)
          Sets method name to be called in schedule task implementation class while executing schedule job
 void setName(java.lang.String name)
          Sets schedule job name.
 void setParams(java.util.HashMap params)
          Sets map containing schedule job parameter name and parameter value object.
 void setParamTypes(java.lang.Class[] paramTypes)
          Sets Schedule job parameter types.
 void setRetrycount(int retrycount)
          Sets Schedule job retry count.
 void setRetrycount(java.lang.Long retrycount)
          Sets Schedule job retry count.
 void setTaskClass(java.lang.Class taskClass)
          Sets schedule task implementation class object.
 void setTaskClass(java.lang.String taskClass)
          Sets schedule task implementation class name.
 void setTaskClassName(java.lang.String taskClassName)
          Sets schedule task implementation class name.
 void setTaskKey(java.lang.String taskKey)
          Sets schedule task key in OIM repository.
 void setTaskName(java.lang.String jobName)
          Sets schedule task name.
 void setTaskStatus(boolean taskStatus)
          Sets Schedule job status.

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Constructor Detail

JobDetails

public JobDetails(ScheduledTask task,
                  java.lang.String jobName,
                  java.util.HashMap params)
Constructs a JobDetails object.
Parameters:
task - Schedule task object containing schedule task information e.g. Schedule task name, task class name, task retry count
jobName - Job Name
params - Map of schedule job parameter name and value object

JobDetails

public JobDetails(java.lang.String name,
                  java.lang.Class jobClass,
                  java.util.HashMap attributes)
Constructs a JobDetails object.
Parameters:
name - Job Name
jobClass - Schedule task implementation class object
attributes - Map of schedule job parameter name and value object

JobDetails

public JobDetails(java.lang.String name,
                  java.lang.Class jobClass,
                  java.lang.String method,
                  java.util.HashMap params,
                  java.lang.Class[] paramTypes)
Constructs a JobDetails object.
Parameters:
name - job Name
jobClass - Schedule task implementation class name
method - Method name to be called in schedule task implementation class while executing schedule job
params - Map of schedule job parameter name and value object
paramTypes - Schedule job parameters types

JobDetails

public JobDetails()
Constructs a JobDetails object.

Method Detail

getTaskClass

public java.lang.Class getTaskClass()
Provides the schedule task implementation class object.
Returns:
Schedule task implementation class object

getMethod

public java.lang.String 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

public java.lang.String 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

public void setConcurrent(java.lang.String concurrent)
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

public java.util.HashMap 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

public java.lang.Class[] getParamTypes()
Provides Schedule job parameter types. Supported types are String, Boolean, Number.
Returns:
Schedule job parameter types

getAttributes

public java.util.HashMap 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

public void setName(java.lang.String name)
Sets schedule job name.
Parameters:
name - Schedule job name

setTaskClass

public void setTaskClass(java.lang.Class taskClass)
Sets schedule task implementation class object.
Parameters:
taskClass - Schedule task implementation class object

setTaskClass

public void setTaskClass(java.lang.String taskClass)
Sets schedule task implementation class name.
Parameters:
taskClass - Schedule task implementation class name

setMethod

public void setMethod(java.lang.String method)
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

public void setParams(java.util.HashMap params)
Sets map containing schedule job parameter name and parameter value object.
Parameters:
params - Map containing schedule job parameter name and parameter value object

setAttributes

public void setAttributes(java.util.HashMap params)
Sets map containing schedule job parameter name and parameter value object.
Parameters:
params - map containing schedule job parameter name and parameter value object

setParamTypes

public void setParamTypes(java.lang.Class[] paramTypes)
Sets Schedule job parameter types. Supported types are String, Boolean, Number.
Parameters:
paramTypes - Schedule job parameter types

getTaskClassName

public java.lang.String getTaskClassName()
Provides schedule task implementation class name.
Returns:
Schedule task implementation class name

setTaskClassName

public void setTaskClassName(java.lang.String taskClassName)
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

public void setRetrycount(java.lang.Long retrycount)
Sets Schedule job retry count.
Parameters:
retrycount - Schedule job retry count

getTaskName

public java.lang.String getTaskName()
Provides Schedule task name.
Returns:
Schedule task name

setTaskName

public void setTaskName(java.lang.String jobName)
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

public java.util.Date getLastModifyDate()
Provides the last modification date of schedule job.
Returns:
Last modification date of schedule job

setLastModifyDate

public void setLastModifyDate(java.util.Date lastModifyDate)
Sets last modification date of schedule job.
Parameters:
lastModifyDate - Last modification date of schedule job

getJobListener

public java.lang.String getJobListener()
Provides schedule job listener.
Returns:
Schedule job listener

setJobListener

public void setJobListener(java.lang.String jobListener)
Sets schedule job listener.
Parameters:
jobListener - Schedule job listener

getTaskKey

public java.lang.String getTaskKey()
Provides schedule task key in OIM repository.
Returns:
Schedule task key in OIM repository

setTaskKey

public void setTaskKey(java.lang.String taskKey)
Sets schedule task key in OIM repository.
Parameters:
taskKey - Schedule task key in OIM repository

getJobScheduleType

public java.lang.String getJobScheduleType()
Provides Schedule job's scheduling type. Supported values are 'None', 'Periodic', 'Cron', 'Single'.
Returns:
Schedule job's scheduling type

setJobScheduleType

public void setJobScheduleType(java.lang.String jobScheduleType)
Sets Schedule job's scheduling type. Supported values are 'None', 'Periodic', 'Cron', 'Single'.
Parameters:
jobScheduleType - Schedule job's scheduling type

getCronScheduleType

public java.lang.String getCronScheduleType()
Provides schedule job's cron schedule types. Supported values are 'DAILY', 'WEEKLY', 'MONTHLY', 'MONTHLYWEEKDAYS', 'YEARLY'.
Returns:
Schedule job's cron schedule types

setCronScheduleType

public void setCronScheduleType(java.lang.String cronScheduleType)
Sets schedule job's cron schedule types. Supported values are 'DAILY', 'WEEKLY', 'MONTHLY', 'MONTHLYWEEKDAYS', 'YEARLY'.
Parameters:
cronScheduleType - Schedule job's cron schedule types

Skip navigation links


Copyright © 2015, Oracle and/or its affiliates. All rights reserved.