org.sape.carbon.services.scheduler
Interface FixedRateTaskConfiguration

All Superinterfaces:

BaseTaskConfiguration, Configuration

public interface FixedRateTaskConfiguration

extends BaseTaskConfiguration

This is the configuration interface used to create fixed rate tasks within the Scheduler Service. Fixed rate tasks are scheduled to execute at fixed times (e.g. every hour on the hour or every day at 3:30 AM). Available rates are mintutely, hourly, daily, weekly, monthly (every 30 days), and annually (every 365 days). The same task can be scheduled multiple times to achieve rates in between (e.g. twice a day). If the frequency of the task execution is more important than when the task executes, a fixed delay task may be more appropriate. Also see java.util.Timer for a definition of fixed rate.

Valid values for Minute are 0 to 59 inclusive. Valid values for Hour are 0 to 23 inclusive (note no AM or PM). Valid values for DayOfMonth are 1 to 31 inclusive. Month is specified by org.sape.carbon.core.util.calendar.MonthEnum. DayOfWeek is specified by org.sape.carbon.core.util.calendar.DayOfWeekEnum.

The scheduling behavior of FixedRateTasks are as follows:

• If Minute is not specifed, the task is schedule to start at the beginning of each minute. An InvalidConfiguraitonException is thrown if other configuration information is specified.
• If Minute is specifed, but Hour is not, the task is scheduled to run hourly at the minute specifed by Minute. An InvalidConfiguraitonException is thrown if any of DayOfMonth, Month, and DayOfWeek are specifed.
• If Minute and Hour are specifed, but DayOfWeek and DayOfMonth are not, the task is scheduled to run daily at the specified time. An InvalidConfiguraitonException is thrown if Month is specifed.
• If Minute, Hour, and DayOfMonth are specifed, but Month is not, the task is scheduled to run every 30 days starting at the specified day and time. An InvalidConfiguraitonException is thrown if DayOfWeek is specifed.
• If Minute, Hour, DayOfMonth, and Month are specifed, the task is scheduled to run every 365 days starting at the specified date and time. An InvalidConfiguraitonException is thrown if DayOfWeek is specifed.
• If Minute, Hour, and DayOfWeek are specifed, but DayOfMonth and Month are not, the task is scheduled to run every 7 days starting at the specified day and time. An InvalidConfiguraitonException is thrown if Month is specifed.

Since:

carbon 1.0

Version:

$Revision: 1.4 $($Author: dvoet $ / $Date: 2003/05/05 21:21:33 $)

Author:

Douglas Voet, June 2002

See Also:

FixedDelayTaskConfiguration, org.sape.carbon.services.scheduler.ScheduleService, DayOfWeekEnum, MonthEnum, GregorianCalendar, Copyright 2002 Sapient

Method Summary

Integer	getDayOfMonth() Gets the day of the month this task will execute on.
DayOfWeekEnum	getDayOfWeek() Gets the day of week this task will execute on.
Integer	getHour() Gets the hour value this task will execute on.
Integer	getMinute() Gets the minute value this task will execute on.
MonthEnum	getMonth() Gets the month this task will execute on.
void	setDayOfMonth(Integer dayOfMonth) Sets the day of the month this task will execute on.
void	setDayOfWeek(DayOfWeekEnum dayOfWeek) Sets the day of week this task will execute on.
void	setHour(Integer hour) Sets the hour value this task will execute on.
void	setMinute(Integer minute) Sets the minute value this task will execute on.
void	setMonth(MonthEnum month) Sets the month this task will execute on.

Methods inherited from interface org.sape.carbon.services.scheduler.BaseTaskConfiguration

getSchedulableComponent, getScheduledMethod, setSchedulableComponent, setScheduledMethod

Methods inherited from interface org.sape.carbon.core.config.Configuration

clone, getConfigurationInterface, getConfigurationName, getDataStructure, getRootElement, isConfigurationWritable, setConfigurationName, setConfigurationReadOnly

Method Detail

getMinute

public Integer getMinute()

Gets the minute value this task will execute on.

Returns:

minute value this task will execute on

setMinute

public void setMinute(Integer minute)

Sets the minute value this task will execute on.

Parameters:

minute - minute value this task will execute on

getHour

public Integer getHour()

Gets the hour value this task will execute on.

Returns:

hour value this task will execute on

setHour

public void setHour(Integer hour)

Sets the hour value this task will execute on.

Parameters:

hour - hour value this task will execute on

getDayOfMonth

public Integer getDayOfMonth()

Gets the day of the month this task will execute on.

Returns:

day of the month this task will execute on

setDayOfMonth

public void setDayOfMonth(Integer dayOfMonth)

Sets the day of the month this task will execute on.

Parameters:

dayOfMonth - day of the month this task will execute on

getMonth

public MonthEnum getMonth()

Gets the month this task will execute on.

Returns:

month this task will execute on

setMonth

public void setMonth(MonthEnum month)

Sets the month this task will execute on.

Parameters:

month - month this task will execute on

getDayOfWeek

public DayOfWeekEnum getDayOfWeek()

Gets the day of week this task will execute on.

Returns:

day of week this task will execute on

setDayOfWeek

public void setDayOfWeek(DayOfWeekEnum dayOfWeek)

Sets the day of week this task will execute on.

Parameters:

dayOfWeek - day of week this task will execute on