NAME

SemanticWeb::Schema::Schedule - A schedule defines a repeating time period used to describe a regularly occurring Event

VERSION

version v5.0.0

DESCRIPTION

A schedule defines a repeating time period used to describe a regularly occurring Event. At a minimum a schedule will specify repeatFrequency which describes the interval between occurences of the event. Additional information can be provided to specify the schedule more precisely. This includes identifying the day(s) of the week or month when the recurring event will take place, in addition to its start and end time. Schedules may also have start and end dates to indicate when they are active, e.g. to define a limited calendar of events.

ATTRIBUTES

by_day

byDay

Defines the day(s) of the week on which a recurring Event takes place

A by_day should be one of the following types:

InstanceOf['SemanticWeb::Schema::DayOfWeek']

by_month

byMonth

Defines the month(s) of the year on which a recurring Event takes place. Specified as an Integer between 1-12. January is 1.

A by_month should be one of the following types:

InstanceOf['SemanticWeb::Schema::Integer']

by_month_day

byMonthDay

Defines the day(s) of the month on which a recurring Event takes place. Specified as an Integer between 1-31.

A by_month_day should be one of the following types:

InstanceOf['SemanticWeb::Schema::Integer']

event_schedule

eventSchedule

Associates an Event with a Schedule. There are circumstances where it is preferable to share a schedule for a series of repeating events rather than data on the individual events themselves. For example, a website or application might prefer to publish a schedule for a weekly gym class rather than provide data on every event. A schedule could be processed by applications to add forthcoming events to a calendar. An Event that is associated with a Schedule using this property should not have startDate or endDate properties. These are instead defined within the associated Schedule, this avoids any ambiguity for clients using the data. The propery might have repeated values to specify different schedules, e.g. for different months or seasons.

A event_schedule should be one of the following types:

InstanceOf['SemanticWeb::Schema::Duration']

except_date

exceptDate

Defines a Date or DateTime during which a scheduled Event will not take place. The property allows exceptions to a Schedule to be specified. If an exception is specified as a DateTime then only the event that would have started at that specific date and time should be excluded from the schedule. If an exception is specified as a Date then any event that is scheduled for that 24 hour period should be excluded from the schedule. This allows a whole day to be excluded from the schedule without having to itemise every scheduled event.

A except_date should be one of the following types:

Str

repeat_count

repeatCount

Defines the number of times a recurring Event will take place

A repeat_count should be one of the following types:

InstanceOf['SemanticWeb::Schema::Integer']

repeat_frequency

repeatFrequency

Defines the frequency at which Events will occur according to a schedule Schedule. The intervals between events should be defined as a Duration of time.

A repeat_frequency should be one of the following types:

InstanceOf['SemanticWeb::Schema::Duration']
Str

SEE ALSO

SemanticWeb::Schema::Intangible

SOURCE

The development version is on github at https://github.com/robrwo/SemanticWeb-Schema and may be cloned from git://github.com/robrwo/SemanticWeb-Schema.git

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/robrwo/SemanticWeb-Schema/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHOR

Robert Rothenberg <rrwo@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018-2019 by Robert Rothenberg.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)