org.apache.manifoldcf.crawler.interfaces
Class ScheduleRecord

java.lang.Object
  org.apache.manifoldcf.crawler.interfaces.ScheduleRecord

public class ScheduleRecord
extends java.lang.Object

This class describes a single scheduling record, which describes a matching date and time for a job to be started or unblocked. It also describes the throttle rate that should be in effect for the interval. This class is immutable.

Field Summary

static java.lang.String	_rcsid
protected EnumeratedValues	dayOfMonth
protected EnumeratedValues	dayOfWeek
protected java.lang.Long	duration
protected EnumeratedValues	hourOfDay
protected EnumeratedValues	minutesOfHour
protected EnumeratedValues	monthOfYear
protected java.lang.String	timezone
protected EnumeratedValues	year

Constructor Summary

ScheduleRecord(EnumeratedValues dayOfWeek, EnumeratedValues monthOfYear, EnumeratedValues dayOfMonth, EnumeratedValues year, EnumeratedValues hourOfDay, EnumeratedValues minutesOfHour, java.lang.String timezone, java.lang.Long duration)
Constructor.

Method Summary

EnumeratedValues	getDayOfMonth() Get the day of month.
EnumeratedValues	getDayOfWeek() Get the day of week.
java.lang.Long	getDuration() Get the window duration.
EnumeratedValues	getHourOfDay() Get the hour of the day.
EnumeratedValues	getMinutesOfHour() Get the minutes of the hour.
EnumeratedValues	getMonthOfYear() Get the month of year.
java.lang.String	getTimezone() Get the timezone.
EnumeratedValues	getYear() Get the year.

Methods inherited from class java.lang.Object

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

Field Detail

_rcsid

public static final java.lang.String _rcsid

See Also:

Constant Field Values

dayOfWeek

protected EnumeratedValues dayOfWeek

monthOfYear

protected EnumeratedValues monthOfYear

dayOfMonth

protected EnumeratedValues dayOfMonth

year

protected EnumeratedValues year

hourOfDay

protected EnumeratedValues hourOfDay

minutesOfHour

protected EnumeratedValues minutesOfHour

timezone

protected java.lang.String timezone

duration

protected java.lang.Long duration

Constructor Detail

ScheduleRecord

public ScheduleRecord(EnumeratedValues dayOfWeek,
                      EnumeratedValues monthOfYear,
                      EnumeratedValues dayOfMonth,
                      EnumeratedValues year,
                      EnumeratedValues hourOfDay,
                      EnumeratedValues minutesOfHour,
                      java.lang.String timezone,
                      java.lang.Long duration)

Constructor.

Parameters:

dayOfWeek - is the day-of-week enumeration.

monthOfYear - is the month-of-year enumeration.

dayOfMonth - is the day-of-month enumeration.

year - is the year enumeration.

hourOfDay - is the time of day enumeration.

minutesOfHour - is the minutes enumeration.

timezone - is the timezone.

duration - is the window duration, or null if infinite.

Method Detail

getDayOfWeek

public EnumeratedValues getDayOfWeek()

Get the day of week.

Returns:

the enumeration or null.

getMonthOfYear

public EnumeratedValues getMonthOfYear()

Get the month of year.

Returns:

the enumeration or null.

getDayOfMonth

public EnumeratedValues getDayOfMonth()

Get the day of month.

Returns:

the enumeration or null.

getYear

public EnumeratedValues getYear()

Get the year.

Returns:

the enumeration or null.

getHourOfDay

public EnumeratedValues getHourOfDay()

Get the hour of the day.

Returns:

the enumeration or null.

getMinutesOfHour

public EnumeratedValues getMinutesOfHour()

Get the minutes of the hour.

Returns:

the enumeration or null.

getTimezone

public java.lang.String getTimezone()

Get the timezone.

Returns:

the timezone or null.

getDuration

public java.lang.Long getDuration()

Get the window duration.

Returns:

the duration or null.