org.pentaho.platform.api.scheduler2

Interface IJobTrigger

All Known Implementing Classes:

ComplexJobTrigger, CronJobTrigger, JobTrigger, SimpleJobTrigger

public interface IJobTrigger

Method Summary

Modifier and Type	Method and Description
String	getCronString() Returns the Cron String used by quartz Scheduler
long	getDuration()
Date	getEndTime() Returns the trigger end time.
Date	getStartTime() Returns the trigger start time.
String	getUiPassParam()
void	setCronString(String cronString) Sets the cron String used by the quartz scheduler
void	setDuration(long duration)
void	setEndTime(Date endTime) Sets the trigger end time.
void	setStartTime(Date startTime) Sets the trigger start time.
void	setUiPassParam(String uiPassParam) The value of this field comes from the UI and is persisted in quartz but not used by quartz or the server.

Method Detail

getStartTime

Date getStartTime()

Returns the trigger start time.

Returns:

the trigger start time.

setStartTime

void setStartTime(Date startTime)

Sets the trigger start time.

Parameters:

startTime - when to start the trigger. If null the trigger starts immediately.

getEndTime

Date getEndTime()

Returns the trigger end time.

Returns:

the trigger end time.

setEndTime

void setEndTime(Date endTime)

Sets the trigger end time.

Parameters:

endTime - when to end the trigger. If null the trigger runs indefinitely

getUiPassParam

String getUiPassParam()

Returns:

the uiPassParam

setUiPassParam

void setUiPassParam(String uiPassParam)

The value of this field comes from the UI and is persisted in quartz but not used by quartz or the server. It is strictly a way for the UI to persist something. In the present implementation, this field holds the scheduleType.

Parameters:

uiPassParam - A User Interface provided string

getCronString

String getCronString()

Returns the Cron String used by quartz Scheduler

Returns:

the cronString

setCronString

void setCronString(String cronString)

Sets the cron String used by the quartz scheduler

Parameters:

cronString - the cronString to set

getDuration

long getDuration()

Returns:

a long that represents in milliseconds how long this trigger should be in effect once triggered

setDuration

void setDuration(long duration)

Parameters:

duration - Sets the length of time in milliseconds that this trigger should be in effect.