Name

condition date range, conditiondaterange, kPMConditionConditionDateRange — Conditional on the date falling within a specific period.

Synopsis

condition date range structure { invert, type, not before, not after };
invert : boolean, default, optional
type : string, choice
not before : date, optional
not after : date, optional

Description

Conditional on the date falling within a specific period.

date range provides a flexible means of testing if the current date falls within or without a specific period.

Both not before and not after fields are optional. Inclusion of either, or both, allow the condition to represent the following tests:

now is before a specific date;
now is after a specific date;
now is within a specific date range;
now is not within a specific date range.

Fields

invert. Invert the condition's conclusion.

Conditions are designed to positively identify specific states. Many events will want a condition to confirm that a specific state is not occuring. To reverse the role of a positive condition, use the invert field.

If a condition is true, and the invert field is set, the condition will invert the true and return false.

If a condition is false, and the invert field is set, the condition will invert the false and return true.

invert is a boolean. If invert is omitted, the default false is used. invert is optional.

type. Type of condition to test.

type is a string. type must be date range, kPMConditionType_DateRange.

not before. The date is not before this date.

not before is a date. not before is optional.

not after. The date is not after this date.

not after is a date. not after is optional.