NthIncludedDayTrigger Class

Quartz.NET API Documentation

A trigger which fires on the N^th day of every interval type IntervalTypeWeekly, IntervalTypeMonthly or IntervalTypeYearly that is not excluded by the associated calendar.

Inheritance Hierarchy

System Object
Quartz Trigger
Quartz NthIncludedDayTrigger

Namespace: Quartz
Assembly: Quartz (in Quartz.dll) Version: 1.0.3.3

Syntax

C++

Copy to Clipboard Print

[SerializableAttribute]
public class NthIncludedDayTrigger : Trigger

[SerializableAttribute]
public class NthIncludedDayTrigger : Trigger

Remarks

When determining what the N^th day of the month or year is, NthIncludedDayTrigger will skip excluded days on the associated calendar. This would commonly be used in an N^th business day situation, in which the user wishes to fire a particular job on the N^th business day (i.e. the 5^th business day of every month). Each NthIncludedDayTrigger also has an associated FireAtTime which indicates at what time of day the trigger is to fire.

All NthIncludedDayTriggers default to a monthly interval type (fires on the Nth day of every month) with N = 1 (first non-excluded day) and FireAtTime set to 12:00 PM (noon). These values can be changed using the N, IntervalType, and FireAtTime methods. Users may also want to note the NextFireCutoffInterval and NextFireCutoffInterval methods.

Take, for example, the following calendar:

Copy to Clipboard Print

July                  August                September
Su Mo Tu We Th Fr Sa   Su Mo Tu We Th Fr Sa   Su Mo Tu We Th Fr Sa
1  W       1  2  3  4  5  W                1  2  W
W  H  5  6  7  8  W    W  8  9 10 11 12  W    W  H  6  7  8  9  W
W 11 12 13 14 15  W    W 15 16 17 18 19  W    W 12 13 14 15 16  W
W 18 19 20 21 22  W    W 22 23 24 25 26  W    W 19 20 21 22 23  W
W 25 26 27 28 29  W    W 29 30 31             W 26 27 28 29 30
W

July                  August                September
Su Mo Tu We Th Fr Sa   Su Mo Tu We Th Fr Sa   Su Mo Tu We Th Fr Sa
1  W       1  2  3  4  5  W                1  2  W
W  H  5  6  7  8  W    W  8  9 10 11 12  W    W  H  6  7  8  9  W
W 11 12 13 14 15  W    W 15 16 17 18 19  W    W 12 13 14 15 16  W
W 18 19 20 21 22  W    W 22 23 24 25 26  W    W 19 20 21 22 23  W
W 25 26 27 28 29  W    W 29 30 31             W 26 27 28 29 30
W

Where W's represent weekend days, and H's represent holidays, all of which are excluded on a calendar associated with an NthIncludedDayTrigger with n=5 and intervalType=IntervalTypeMonthly. In this case, the trigger would fire on the 8^th of July (because of the July 4 holiday), the 5^th of August, and the 8^th of September (because of Labor Day).