com.hof.mi.web.service.schedule

Class ScheduleFrequency

java.lang.Object

com.hof.mi.web.service.schedule.ScheduleFrequency

Direct Known Subclasses:

AnnualFrequency, BiannualFrequency, DailyFrequency, EndOfMonthFrequency, FortnightlyFrequency, MinutesFrequency, MonthlyFrequency, OnceFrequency, QuarterlyFrequency, WeekdaysFrequency, WeeklyFrequency

public abstract class ScheduleFrequency
extends java.lang.Object

Base class for all frequency types. This class holds the database attributes for a frequency schedule. It is the responsibility of each subclass to provide user-friendly methods to set and get useful data based on the database value of each field. Eg. Day of month is sometimes stored in frequency unit, and sometimes not, if the schedule type has day of month at all. The subclass will enforce validation and also abstract this from the user.

Author:

TimG

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	dayOrdinals This list is sorted in day order and can be used to reference which day ordinal corresponds to each day name specified by the day name constants in this class.
protected java.lang.String	frequencyCode
protected java.lang.String	frequencyTypeCode
protected java.lang.Integer	frequencyUnit
static java.lang.String	FRIDAY
protected java.lang.Integer	localRunTime
protected java.lang.String	localTimezoneCode
static java.lang.String	MONDAY
static java.lang.String	SATURDAY
static java.lang.String	SUNDAY
static java.lang.String	THURSDAY
static java.lang.String	TUESDAY
static java.lang.String	WEDNESDAY

Constructor Summary

Constructors

Constructor and Description
ScheduleFrequency()
ScheduleFrequency(java.lang.String frequencyTypeCode)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFrequencyCode()
java.lang.String	getFrequencyTypeCode()
java.lang.Integer	getFrequencyUnit()
java.lang.Integer	getLocalRunTime() Seconds from midnight that this schedule will run (relative to this schedule's timezone).
java.lang.String	getLocalTimezoneCode() UPPER CASE full time zone code (ie.
void	setFrequencyCode(java.lang.String frequencyCode)
void	setFrequencyTypeCode(java.lang.String frequencyTypeCode)
void	setFrequencyUnit(java.lang.Integer frequencyUnit)
void	setLocalRunTime(java.lang.Integer localRunTime) Seconds from midnight that this schedule will run (relative to this schedule's timezone).
void	setLocalTimezoneCode(java.lang.String timezoneCode) UPPER CASE full time zone code (ie.

Methods inherited from class java.lang.Object

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

Field Detail

SUNDAY

public static final java.lang.String SUNDAY

See Also:

Constant Field Values

MONDAY

public static final java.lang.String MONDAY

See Also:

Constant Field Values

TUESDAY

public static final java.lang.String TUESDAY

See Also:

Constant Field Values

WEDNESDAY

public static final java.lang.String WEDNESDAY

See Also:

Constant Field Values

THURSDAY

public static final java.lang.String THURSDAY

See Also:

Constant Field Values

FRIDAY

public static final java.lang.String FRIDAY

See Also:

Constant Field Values

SATURDAY

public static final java.lang.String SATURDAY

See Also:

Constant Field Values

dayOrdinals

public static final java.util.List<java.lang.String> dayOrdinals

This list is sorted in day order and can be used to reference which day ordinal corresponds to each day name specified by the day name constants in this class.

localTimezoneCode

protected java.lang.String localTimezoneCode

localRunTime

protected java.lang.Integer localRunTime

frequencyCode

protected java.lang.String frequencyCode

frequencyUnit

protected java.lang.Integer frequencyUnit

frequencyTypeCode

protected java.lang.String frequencyTypeCode

Constructor Detail

ScheduleFrequency

public ScheduleFrequency()

ScheduleFrequency

public ScheduleFrequency(java.lang.String frequencyTypeCode)

Method Detail

getFrequencyCode

public java.lang.String getFrequencyCode()

getFrequencyUnit

public java.lang.Integer getFrequencyUnit()

getFrequencyTypeCode

public java.lang.String getFrequencyTypeCode()

setFrequencyTypeCode

public void setFrequencyTypeCode(java.lang.String frequencyTypeCode)

getLocalRunTime

public java.lang.Integer getLocalRunTime()

Seconds from midnight that this schedule will run (relative to this schedule's timezone).

setLocalRunTime

public void setLocalRunTime(java.lang.Integer localRunTime)

Seconds from midnight that this schedule will run (relative to this schedule's timezone).

getLocalTimezoneCode

public java.lang.String getLocalTimezoneCode()

UPPER CASE full time zone code (ie. AUSTRALIA/SYDNEY, etc.) that will be used to translate the specified local run time into the YF server's time.

setLocalTimezoneCode

public void setLocalTimezoneCode(java.lang.String timezoneCode)

UPPER CASE full time zone code (ie. AUSTRALIA/SYDNEY, etc.) that will be used to translate the specified local run time into the YF server's time.

setFrequencyCode

public void setFrequencyCode(java.lang.String frequencyCode)

setFrequencyUnit

public void setFrequencyUnit(java.lang.Integer frequencyUnit)