Module time-constraint

Package com.here.mom.component.time-constraint

Parts

Enums

Date

part Date extends TimeConstraint

Module time-constraint

A single date represented as array [YYYY, MM, DD]

Property Type Modifier Description
tcType "Date"
fromEnd IsFromEnd optional From End attribute allows time to be specified "from the end" of a standard time period such as month or year.
date integer list
Constraint Expression Description
dateEmptyOrSize3 (is-empty(.date) (size(.date) == 3))

DatePattern

part DatePattern extends TimeConstraint

Module time-constraint

A TimeConstraint that applies to certain patterns of Dates in a recurring manner. Optionally restricted to time windows and with the option to exclude certain dates.

Property Type Modifier Description
tcType "DatePattern"
fromEnd IsFromEnd optional From End attribute allows time to be specified "from the end" of a standard time period such as month or year.
daysOfWeek DaysOfWeek optional Day of Week represnts what happens at this day of week, each week, for an open-ended period of time.
daysOfMonth DaysOfMonth optional If a condition is in effect on the same date each month.
dayPattern DayPattern optional If a condition is in effect on even or odd days.
monthsOfYear MonthsOfYear optional If a condition is in effect during the same month(s) of each year. Start and End fields contain values relating

to the month of the year (from 1 to 12)
weeksOfYear WeeksOfYear optional If a condition is in effect on the same week of each year. Week number (from 1 to 53)
weeksOfMonth WeeksOfMonth optional If a condition is in effect during the same week of each month. Start and End fields contain values relating

to the week of the month (from 1 to 5)
timeWindows SimpleTimeWindow set Time Window signifies start and end time of a constraint.
holiday boolean optional It identifies particular day is holiday or not.
exception TimeConstraintException optional
monthDayRange MonthDayRange optional If a condition is in effect for a date range each year.

DateWindow

part DateWindow extends TimeConstraint

Module time-constraint

Property Type Modifier Description
tcType "DateWindow"
fromEnd IsFromEnd optional From End attribute allows time to be specified "from the end" of a standard time period such as month or year.
startDate integer list Start Date indicates the date on which the constraint begins.
endDate integer list End Date indicates the date on which the constraint ends.
timeWindows SimpleTimeWindow set Time Window signifies start and end time of a constraint.
Constraint Expression Description
startDateEmptyOrSize3 (is-empty(.startDate) (size(.startDate) == 3))
endDateEmptyOrSize3 (is-empty(.endDate) (size(.endDate) == 3))

DayOfMonth

part DayOfMonth

Module time-constraint

Property Type Modifier Description
day integer optional If a condition is in effect on the same date each month. Start and End fields contain values from 1 to 31,

representing the dates in each month that the restriction is effective.
Constraint Expression Description
dayMin1 (non-empty(.day) -> (head(.day) >= 1))
dayMax31 (non-empty(.day) -> (head(.day) <= 31))

DayPattern

enum DayPattern

Module time-constraint

Value Description
UNDEFINED
EVEN
ODD

DaysOfMonth

part DaysOfMonth

Module time-constraint

Property Type Modifier Description
alias DayOfMonth set

DaysOfWeek

part DaysOfWeek

Module time-constraint

Property Type Modifier Description
alias WeekDay set

DummyForUnion

part DummyForUnion

Module time-constraint

IsFromEnd

part IsFromEnd

Module time-constraint

Property Type Modifier Description
alias boolean

Month

enum Month

Module time-constraint

Value Description
UNDEFINED
NON
JAN
FEB
MAR
APR
MAY
JUN
JUL
AUG
SEP
OCT
NOV
DEC
ALL

MonthDayRange

part MonthDayRange

Module time-constraint

Range of month and day within a single 12-month span.

The span can wrap around from 31 December to 1 January. That is, the start date can be a later calendar date than the end date. For example, start = 1 November, end = 30 March, designating the five consecutive months November of one year through March of the following year.

Property Type Modifier Description
startMonth integer
startDay integer
endMonth integer
endDay integer
Constraint Expression Description
startMonthMin1 (.startMonth >= 1)
startMonthMax12 (.startMonth <= 12)
startDayMin1 (.startDay >= 1)
startDayMax31 (.startDay <= 31)
endMonthMin1 (.endMonth >= 1)
endMonthMax12 (.endMonth <= 12)
endDayMin1 (.endDay >= 1)
endDayMax31 (.endDay <= 31)
daysInOrder ((.startMonth == .endMonth) -> (.startDay < .endDay))

MonthsOfYear

part MonthsOfYear

Module time-constraint

Property Type Modifier Description
alias Month set

Recurring

part Recurring extends TimeConstraint

Module time-constraint

Property Type Modifier Description
tcType "Recurring"
fromEnd IsFromEnd optional From End attribute allows time to be specified "from the end" of a standard time period such as month or year.
timeWindows SimpleTimeWindow set Time Window signifies start and end time of a constraint.
daysOfWeek DaysOfWeek optional Day of Week represnts the days of the week, each week, for an open-ended period of time.
external boolean optional This field provides a method of accessing external lists of commonly used dates.

- For example

the specific holidays for each country or the dates that constitute the changes of season may be

listed separately. Only Easter is used as an external date in Europe.

- Do not apply external dates

outside Europe.

- As of now to handle only one value that is EASTER, type is boolean.
exception TimeConstraintException optional Union of polymorphic types implementing: TimeConstraint

SimpleTimeWindow

part SimpleTimeWindow

Module time-constraint

Subtypes TimeWindow

Property Type Modifier Description
start SimpleTime optional Start Time defines the beginning of a time period in terms of hours and minutes(0 to 2400)
end SimpleTime optional End Time defines the end of a time perios in terms of hours and minutes(0 to 2400)

TcType

enum TcType

Module time-constraint

Discriminants for TimeConstraint > tcType

Value Description
DATE
DATE_PATTERN
RECURRING
DATE_WINDOW

TimeConstraint

abstract part TimeConstraint

Module time-constraint

Subtypes Date, DatePattern, DateWindow, Recurring

Property Type Modifier Description
fromEnd IsFromEnd optional From End attribute allows time to be specified "from the end" of a standard time period such as month or year.

TimeConstraintException

part TimeConstraintException

Module time-constraint

Property Type Modifier Description
timeConstraints TimeConstraint set Union of polymorphic types implementing: TimeConstraint

TimeWindow

part TimeWindow extends SimpleTimeWindow

Module time-constraint

Property Type Modifier Description
start SimpleTime optional Start Time defines the beginning of a time period in terms of hours and minutes(0 to 2400)
end SimpleTime optional End Time defines the end of a time perios in terms of hours and minutes(0 to 2400)
exceptions TimeConstraint list Union of polymorphic types implementing: TimeConstraint

WeekDay

enum WeekDay

Module time-constraint

Week Day identifies the day of the week.

Value Description
UNDEFINED
MON
TUE
WED
THU
FRI
SAT
SUN

WeeksOfMonth

part WeeksOfMonth

Module time-constraint

Property Type Modifier Description
alias integer set

WeeksOfYear

part WeeksOfYear

Module time-constraint

Property Type Modifier Description
alias integer set

results matching ""

    No results matching ""