[Index]

schedules:yearly


A schedule for the periods of the year. The periods may be specified either as the dates of days of the year or as months.

The format for dates is MM-dd, i.e. 03-02 is The second of March.

The format for months is either the month number, 1 to 12 or one of JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER (case insensitive).A schedule for a range of months, or a month. The month is specified as an integer between 1 and 12 where 1 is January and 12 is December.


Property Summary

fromDate The from month and day.
fromMonth The from month.
inMonth The month in which this schedule is for.
onDate The day on which this schedule is for.
refinement Provide a refinement to this schedule.
toDate The to month and day.
toMonth The to month.

Example Summary

Example 1 A schedule for two different month ranges.
Example 2 A from day of year to day of year example.
Example 3 An on day of year example.

Property Detail

fromDate

Configured ByATTRIBUTE
AccessREAD_WRITE

The from month and day.

fromMonth

Configured ByATTRIBUTE
AccessREAD_WRITE
RequiredNo, defaults to 1 (January).

The from month.

inMonth

Configured ByATTRIBUTE
AccessWRITE_ONLY
RequiredNo.

The month in which this schedule is for. This has the same effect as setting fromMonth and toMonth to the same thing.

onDate

Configured ByATTRIBUTE
AccessWRITE_ONLY
RequiredNo.

The day on which this schedule is for. This has the same effect as setting fromDate and toDate to the same thing.

refinement

Configured ByELEMENT
AccessREAD_WRITE
RequiredNo.

Provide a refinement to this schedule.

toDate

Configured ByATTRIBUTE
AccessREAD_WRITE

The to month and day.

toMonth

Configured ByATTRIBUTE
AccessREAD_WRITE
RequiredNo, defaults to 12 (December).

The to month.


Examples

Example 1

A schedule for two different month ranges. From April to September the job will run daily at 10 am, and from October to March the job will run daily at 11 am.

<schedules:list xmlns:schedules="http://rgordon.co.uk/oddjob/schedules">
    <schedules>
        <schedules:yearly fromMonth="4" toMonth="9">
            <refinement>
                <schedules:daily at="10:00"/>
            </refinement>
        </schedules:yearly>
        <schedules:yearly fromMonth="10" toMonth="3">
            <refinement>
                <schedules:daily at="11:00"/>
            </refinement>
        </schedules:yearly>
    </schedules>
</schedules:list>
Instead of month numbers, English month names can be used. This is equivalent to the above.
<schedules:list xmlns:schedules="http://rgordon.co.uk/oddjob/schedules">
    <schedules>
        <schedules:yearly fromMonth="April" toMonth="September">
            <refinement>
                <schedules:daily at="10:00"/>
            </refinement>
        </schedules:yearly>
        <schedules:yearly fromMonth="October" toMonth="March">
            <refinement>
                <schedules:daily at="11:00"/>
            </refinement>
        </schedules:yearly>
    </schedules>
</schedules:list>

Example 2

A from day of year to day of year example.

<schedules:yearly fromDate="12-25" toDate="12-26" xmlns:schedules="http://rgordon.co.uk/oddjob/schedules"/>

Example 3

An on day of year example.

<schedules:yearly onDate="01-01" xmlns:schedules="http://rgordon.co.uk/oddjob/schedules"/>


(c) R Gordon Ltd 2005 - Present