org.kuali.ole.sys.batch

Class Job

java.lang.Object

org.kuali.ole.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

Fields

Modifier and Type	Field and Description
static String	JOB_RUN_END_STEP
static String	JOB_RUN_START_STEP
static String	MASTER_JOB_NAME
static String	RUN_DATE_CUTOFF_PARM_NM
static String	STEP_RUN_ON_DATE_PARM_NM
static String	STEP_RUN_PARM_NM
static String	STEP_USER_PARM_NM

Constructor Summary

Constructors

Constructor and Description
Job()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(org.quartz.JobExecutionContext jobExecutionContext)
protected static Calendar	getCutoffWindowBeginning(Date runDateToCheck, org.kuali.rice.core.api.datetime.DateTimeService dateTimeService) Defines the beginning of the cut off window
protected static Calendar	getCutoffWindowEnding(Date runDateToCheck, org.kuali.rice.core.api.datetime.DateTimeService dateTimeService, String[] cutOffTime) Defines the end of the cut off window
protected String	getMachineName()
org.apache.log4j.Appender	getNdcAppender()
static OleSelectDocumentService	getOleSelectDocumentService()
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
List<Step>	getSteps()
void	interrupt()
protected boolean	isNotRunnable()
static boolean	isPastCutoffWindow(Date date, Collection<String> runDates) Deprecated. "Implementing institutions likely want to call Job#withinCutoffWindowForDate"
protected String	jobDataMapToString(org.quartz.JobDataMap jobDataMap)
static boolean	runStep(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService, String jobName, int currentStepNumber, Step step, Date jobRunDate)
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)
void	setNdcAppender(org.apache.log4j.Appender ndcAppender)
void	setNotRunnable(boolean notRunnable)
void	setOleSelectDocumentService(OleSelectDocumentService oleSelectDocumentService)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)
void	setSchedulerService(SchedulerService schedulerService)
void	setSteps(List<Step> steps)
protected static boolean	skipStep(org.kuali.rice.coreservice.framework.parameter.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.
protected static boolean	withinCutoffWindowForDate(Date jobRunDate, Date runDateToCheck, org.kuali.rice.core.api.datetime.DateTimeService dateTimeService, String[] cutOffWindow) Checks if the current jobRunDate is within the cutoff window for the given run date from the RUN_DATE parameter.

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

MASTER_JOB_NAME

public static final String MASTER_JOB_NAME

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

RUN_DATE_CUTOFF_PARM_NM

public static final String RUN_DATE_CUTOFF_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.coreservice.framework.parameter.ParameterService parameterService,
              String jobName,
              int currentStepNumber,
              Step step,
              Date jobRunDate)
                       throws InterruptedException,
                              org.kuali.rice.kew.api.exception.WorkflowException

Throws:

InterruptedException

org.kuali.rice.kew.api.exception.WorkflowException

skipStep

protected static boolean skipStep(org.kuali.rice.coreservice.framework.parameter.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.

withinCutoffWindowForDate

protected static boolean withinCutoffWindowForDate(Date jobRunDate,
                                Date runDateToCheck,
                                org.kuali.rice.core.api.datetime.DateTimeService dateTimeService,
                                String[] cutOffWindow)

Checks if the current jobRunDate is within the cutoff window for the given run date from the RUN_DATE parameter. The window is defined as midnight of the date specified in the parameter to the RUN_DATE_CUTOFF_TIME of the next day.

Parameters:

jobRunDate - the time the job is attempting to start

runDateToCheck - the current member of the appropriate RUN_DATE to check

dateTimeService - an instance of the DateTimeService

Returns:

true if jobRunDate is within the current runDateToCheck window, false otherwise

getCutoffWindowBeginning

protected static Calendar getCutoffWindowBeginning(Date runDateToCheck,
                                org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

Defines the beginning of the cut off window

Parameters:

runDateToCheck - the run date which defines the cut off window

dateTimeService - an implementation of the DateTimeService

Returns:

the begin date Calendar of the cutoff window

getCutoffWindowEnding

protected static Calendar getCutoffWindowEnding(Date runDateToCheck,
                             org.kuali.rice.core.api.datetime.DateTimeService dateTimeService,
                             String[] cutOffTime)

Defines the end of the cut off window

Parameters:

runDateToCheck - the run date which defines the cut off window

dateTimeService - an implementation of the DateTimeService

cutOffTime - an Array in the form of [hour, minute, second] when the cutoff window ends

Returns:

the end date Calendar of the cutoff window

isPastCutoffWindow

public static boolean isPastCutoffWindow(Date date,
                         Collection<String> runDates)

Deprecated. "Implementing institutions likely want to call Job#withinCutoffWindowForDate"

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.coreservice.framework.parameter.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.coreservice.framework.parameter.ParameterService getParameterService()

getSteps

public List<Step> getSteps()

setSchedulerService

public void setSchedulerService(SchedulerService schedulerService)

setDateTimeService

public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

jobDataMapToString

protected String jobDataMapToString(org.quartz.JobDataMap jobDataMap)

getMachineName

protected String getMachineName()

getOleSelectDocumentService

public static OleSelectDocumentService getOleSelectDocumentService()

setOleSelectDocumentService

public void setOleSelectDocumentService(OleSelectDocumentService oleSelectDocumentService)