org.pentaho.platform.api.repository
Interface ISchedule

All Known Implementing Classes:

Schedule

public interface ISchedule

Method Summary

String	getCronString() Get the cron string for this schedule.
String	getDescription()
Date	getEndDate()
String	getGroup()
String	getId() A unique id, often a GUID uniquely identifying the schedule, used to locate the schedule in the Solution Repository (ISolutionRepository implementors).
Date	getLastTrigger()
Integer	getRepeatCount() Get the repeat count (number of times the schedule should run).
Integer	getRepeatInterval() Get repeat time in milliseconds.
int	getRevision()
String	getScheduleReference() Typically the "name" of the schedule
Date	getStartDate()
String	getTitle()
boolean	isCronSchedule() Is this schedule defined by a cron string, or by a repeat time and repeat count? This schedule can be one or the other but not both.
boolean	isRepeatSchedule() Is this schedule defined by a cron string, or by a repeat time and repeat count? This schedule can be one or the other but not both.
void	setCronString(String cronString)
void	setDescription(String description)
void	setEndDate(Date startDate)
void	setGroup(String group)
void	setId(String id)
void	setLastTrigger(Date lastTrigger)
void	setRepeatCount(Integer repeatCount) Set the repeat count (number of times the schedule should run).
void	setRepeatInterval(Integer repeatInterval) Set repeat time in milliseconds (the repeat time is the period of time the scheduler will wait before running the schedule's work again.
void	setScheduleReference(String scheduleRef)
void	setStartDate(Date startDate)
void	setTitle(String title)

Method Detail

getRevision

int getRevision()

Returns:

Returns the revision.

getId

String getId()

A unique id, often a GUID uniquely identifying the schedule, used to locate the schedule in the Solution Repository (ISolutionRepository implementors).

Returns:

getTitle

String getTitle()

getScheduleReference

String getScheduleReference()

Typically the "name" of the schedule

Returns:

setId

void setId(String id)

setTitle

void setTitle(String title)

setScheduleReference

void setScheduleReference(String scheduleRef)

getDescription

String getDescription()

setDescription

void setDescription(String description)

getCronString

String getCronString()

Get the cron string for this schedule. You should only call this method if isCronSchedule() returns true.

Returns:

setCronString

void setCronString(String cronString)

getGroup

String getGroup()

setGroup

void setGroup(String group)

getLastTrigger

Date getLastTrigger()

setLastTrigger

void setLastTrigger(Date lastTrigger)

setRepeatInterval

void setRepeatInterval(Integer repeatInterval)

Set repeat time in milliseconds (the repeat time is the period of time the scheduler will wait before running the schedule's work again.

Parameters:

repeatInterval - Integer repeat time in milliseconds

getRepeatInterval

Integer getRepeatInterval()

Get repeat time in milliseconds. You should only call this method if isRepeatSchedule() returns true.

Returns:

Integer the repeat time in milliseconds

setRepeatCount

void setRepeatCount(Integer repeatCount)

Set the repeat count (number of times the schedule should run).

Parameters:

repeatCount -

getRepeatCount

Integer getRepeatCount()

Get the repeat count (number of times the schedule should run). You should only call this method if isRepeatSchedule() returns true.

Returns:

repeat count

getStartDate

Date getStartDate()

setStartDate

void setStartDate(Date startDate)

getEndDate

Date getEndDate()

setEndDate

void setEndDate(Date startDate)

isCronSchedule

boolean isCronSchedule()

Is this schedule defined by a cron string, or by a repeat time and repeat count? This schedule can be one or the other but not both.

Returns:

true if this is a cron schedule, else false

isRepeatSchedule

boolean isRepeatSchedule()

Is this schedule defined by a cron string, or by a repeat time and repeat count? This schedule can be one or the other but not both.

Returns:

true if this is a repeating schedule, else false