org.kuali.kfs.sys.batch
Class Job

java.lang.Object
  org.kuali.kfs.sys.batch.Job

All Implemented Interfaces:

org.quartz.InterruptableJob, org.quartz.Job, org.quartz.StatefulJob

public class Job
extends Object
implements org.quartz.StatefulJob, org.quartz.InterruptableJob

Field Summary

static String	JOB_RUN_END_STEP
static String	JOB_RUN_START_STEP
static String	STEP_RUN_ON_DATE_PARM_NM
static String	STEP_RUN_PARM_NM
static String	STEP_USER_PARM_NM

Constructor Summary

Job()

Method Summary

void	execute(org.quartz.JobExecutionContext jobExecutionContext)
protected String	getMachineName()
org.apache.log4j.Appender	getNdcAppender()
org.kuali.rice.kns.service.ParameterService	getParameterService()
List<Step>	getSteps()
void	interrupt()
protected boolean	isNotRunnable()
protected String	jobDataMapToString(org.quartz.JobDataMap jobDataMap)
static boolean	runStep(org.kuali.rice.kns.service.ParameterService parameterService, String jobName, int currentStepNumber, Step step, Date jobRunDate)
void	setDateTimeService(org.kuali.rice.kns.service.DateTimeService dateTimeService)
void	setNdcAppender(org.apache.log4j.Appender ndcAppender)
void	setNotRunnable(boolean notRunnable)
void	setParameterService(org.kuali.rice.kns.service.ParameterService parameterService)
void	setSchedulerService(SchedulerService schedulerService)
void	setSteps(List<Step> steps)
protected static boolean	skipStep(org.kuali.rice.kns.service.ParameterService parameterService, Step step, Date jobRunDate) This method determines whether the Job should not run the Step based on the RUN_IND and RUN_DATE Parameters.

Methods inherited from class java.lang.Object

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

Field Detail

JOB_RUN_START_STEP

public static final String JOB_RUN_START_STEP

See Also:

Constant Field Values

JOB_RUN_END_STEP

public static final String JOB_RUN_END_STEP

See Also:

Constant Field Values

STEP_RUN_PARM_NM

public static final String STEP_RUN_PARM_NM

See Also:

Constant Field Values

STEP_RUN_ON_DATE_PARM_NM

public static final String STEP_RUN_ON_DATE_PARM_NM

See Also:

Constant Field Values

STEP_USER_PARM_NM

public static final String STEP_USER_PARM_NM

See Also:

Constant Field Values

Constructor Detail

Job

public Job()

Method Detail

execute

public void execute(org.quartz.JobExecutionContext jobExecutionContext)
             throws org.quartz.JobExecutionException

Specified by:

execute in interface org.quartz.Job

Throws:

org.quartz.JobExecutionException

See Also:

Job.execute(org.quartz.JobExecutionContext)

runStep

public static boolean runStep(org.kuali.rice.kns.service.ParameterService parameterService,
                              String jobName,
                              int currentStepNumber,
                              Step step,
                              Date jobRunDate)
                       throws InterruptedException,
                              org.kuali.rice.kew.exception.WorkflowException

Throws:

InterruptedException

org.kuali.rice.kew.exception.WorkflowException

skipStep

protected static boolean skipStep(org.kuali.rice.kns.service.ParameterService parameterService,
                                  Step step,
                                  Date jobRunDate)

This method determines whether the Job should not run the Step based on the RUN_IND and RUN_DATE Parameters. When RUN_IND exists and equals 'Y' it takes priority and does not consult RUN_DATE. If RUN_DATE exists, but contains an empty value the step will not be skipped.

interrupt

public void interrupt()
               throws org.quartz.UnableToInterruptJobException

Specified by:

interrupt in interface org.quartz.InterruptableJob

Throws:

org.quartz.UnableToInterruptJobException

setParameterService

public void setParameterService(org.kuali.rice.kns.service.ParameterService parameterService)

setSteps

public void setSteps(List<Step> steps)

getNdcAppender

public org.apache.log4j.Appender getNdcAppender()

setNdcAppender

public void setNdcAppender(org.apache.log4j.Appender ndcAppender)

setNotRunnable

public void setNotRunnable(boolean notRunnable)

isNotRunnable

protected boolean isNotRunnable()

getParameterService

public org.kuali.rice.kns.service.ParameterService getParameterService()

getSteps

public List<Step> getSteps()

setSchedulerService

public void setSchedulerService(SchedulerService schedulerService)

setDateTimeService

public void setDateTimeService(org.kuali.rice.kns.service.DateTimeService dateTimeService)

jobDataMapToString

protected String jobDataMapToString(org.quartz.JobDataMap jobDataMap)

getMachineName

protected String getMachineName()