NAME

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

VERSION

version v13.0.0

DESCRIPTION

A schedule defines a repeating time period used to describe a regularly occurring SemanticWeb::Schema::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 SemanticWeb::Schema::Event takes place. May be specified using either SemanticWeb::Schema::DayOfWeek, or alternatively SemanticWeb::Schema::Text conforming to iCal's syntax for byDay recurrence rules.

A by_day should be one of the following types:

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

_has_by_day

A predicate for the "by_day" attribute.

by_month

byMonth

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

A by_month should be one of the following types:

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

_has_by_month

A predicate for the "by_month" attribute.

by_month_day

byMonthDay

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

A by_month_day should be one of the following types:

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

_has_by_month_day

A predicate for the "by_month_day" attribute.

by_month_week

byMonthWeek

Defines the week(s) of the month on which a recurring Event takes place. Specified as an Integer between 1-5. For clarity, byMonthWeek is best used in conjunction with byDay to indicate concepts like the first and third Mondays of a month.

A by_month_week should be one of the following types:

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

_has_by_month_week

A predicate for the "by_month_week" attribute.

duration

The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601).

A duration should be one of the following types:

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

_has_duration

A predicate for the "duration" attribute.

end_date

endDate

The end date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).

A end_date should be one of the following types:

Str

_has_end_date

A predicate for the "end_date" attribute.

end_time

endTime

The endTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to end. For actions that span a period of time, when the action was performed. e.g. John wrote a book from January to *December*. For media, including audio and video, it's the time offset of the end of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

A end_time should be one of the following types:

Str

_has_end_time

A predicate for the "end_time" attribute.

except_date

exceptDate

Defines a SemanticWeb::Schema::Date or SemanticWeb::Schema::DateTime during which a scheduled SemanticWeb::Schema::Event will not take place. The property allows exceptions to a SemanticWeb::Schema::Schedule to be specified. If an exception is specified as a SemanticWeb::Schema::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 SemanticWeb::Schema::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

_has_except_date

A predicate for the "except_date" attribute.

repeat_count

repeatCount

Defines the number of times a recurring SemanticWeb::Schema::Event will take place

A repeat_count should be one of the following types:

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

_has_repeat_count

A predicate for the "repeat_count" attribute.

repeat_frequency

repeatFrequency

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

A repeat_frequency should be one of the following types:

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

_has_repeat_frequency

A predicate for the "repeat_frequency" attribute.

schedule_timezone

scheduleTimezone

Indicates the timezone for which the time(s) indicated in the SemanticWeb::Schema::Schedule are given. The value provided should be among those listed in the IANA Time Zone Database.

A schedule_timezone should be one of the following types:

Str

_has_schedule_timezone

A predicate for the "schedule_timezone" attribute.

start_date

startDate

The start date and time of the item (in [ISO 8601 date format](http://en.wikipedia.org/wiki/ISO_8601)).

A start_date should be one of the following types:

Str

_has_start_date

A predicate for the "start_date" attribute.

start_time

startTime

The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed. e.g. John wrote a book from *January* to December. For media, including audio and video, it's the time offset of the start of a clip within a larger file. Note that Event uses startDate/endDate instead of startTime/endTime, even when describing dates with times. This situation may be clarified in future revisions.

A start_time should be one of the following types:

Str

_has_start_time

A predicate for the "start_time" attribute.

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-2021 by Robert Rothenberg.

This is free software, licensed under:

  The Artistic License 2.0 (GPL Compatible)