org.osid.calendaring

Interface Summary
Interface	Description
Calendar	A calendar defines a collection of events.
CalendarAdminSession	This session creates, updates, and deletes `Calendars.`
CalendarForm	This is the form for creating and updating calendars.
CalendarHierarchyDesignSession	This session defines methods for managing a hierarchy of `Calendar` objects.
CalendarHierarchySession	This session defines methods for traversing a hierarchy of `Calendar` objects.
CalendaringManager	The calendaring manager provides access to calendaring sessions and provides interoperability tests for various aspects of this service.
CalendaringProfile	The `CalendaringProfile` describes the interoperability among calendaring services.
CalendaringProxyManager	The calendaring manager provides access to calendaring sessions and provides interoperability tests for various aspects of this service.
CalendarList	Like all `OsidLists,` `CalendarList` provides a means for accessing `Calendar` elements sequentially either one at a time or many at a time.
CalendarLookupSession	This session provides methods for retrieving `Calendar` objects.
CalendarNode	This interface is a container for a partial hierarchy retrieval.
CalendarNodeList	Like all `OsidLists,` `CalendarNodeList` provides a means for accessing `CalendarNode` elements sequentially either one at a time or many at a time.
CalendarNotificationSession	This session defines methods to receive notifications on adds/changes to `Calendar` objects.
CalendarQuery	This is the query for searching calendars.
CalendarQueryInspector	This is the query inspector for examining calendar queries.
CalendarQuerySession	This session provides methods for searching among `Calendar` objects.
CalendarReceiver	The vault receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Calendar` objects.
CalendarSearch	The interface for governing calendar searches.
CalendarSearchOrder	An interface for specifying the ordering of search results.
CalendarSearchResults	This interface provides a means to capture results of a search.
CalendarSearchSession	This session provides methods for searching among `Calendar` objects.
Commitment	A `Commitment` maps a `Resource` to an `Event.`
CommitmentAdminSession	This session creates, updates, and deletes `Commitments.`
CommitmentCalendarAssignmentSession	This session provides methods to re-assign `Commitments` to `Calendars.`
CommitmentCalendarSession	This session provides methods to retrieve `Commitment` to `Calendar` mappings.
CommitmentForm	This is the form for creating and updating `Commitments.`
CommitmentList	Like all `OsidLists,` `CommitmentList` provides a means for accessing `Commitment` elements sequentially either one at a time or many at a time.
CommitmentLookupSession	This session provides methods for examining event commitments.
CommitmentNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to event commitments.
CommitmentQuery	This is the query for searching commitments.
CommitmentQueryInspector	This is the query inspector for examining commitment queries.
CommitmentQuerySession	This session provides methods for searching `Commitment` objects.
CommitmentReceiver	The event receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Commitments.`
CommitmentSearch	`CommitmentSearch` defines the interface for specifying commitment search options.
CommitmentSearchOrder	An interface for specifying the ordering of search results.
CommitmentSearchResults	This interface provides a means to capture results of a search.
CommitmentSearchSession	This session provides methods for searching `Commitment` objects.
CommitmentSmartCalendarSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
DateTime	The DateTime interface defines a date and/or time.
DateTimeInterval	The `DateTimeInterval` interface defines an interval between two date times.
DateTimeIntervalList	Like all `OsidLists,` `DateTimeIntervalList` provides a means for accessing `DateTimeInterval` elements sequentially either one at a time or many at a time.
DateTimeList	Like all `OsidLists,` `DateTimeList` provides a means for accessing `DateTime` elements sequentially either one at a time or many at a time.
Duration	The `Duration` a length of time.
DurationList	Like all `OsidLists,` `DurationList` provides a means for accessing `Duration` elements sequentially either one at a time or many at a time.
Event	An `Event` represents a span of time and an optional location.
EventAdminSession	This session creates, updates, and deletes `Events.`
EventCalendarAssignmentSession	This session provides methods to re-assign `Events` to `Calendars.`
EventCalendarSession	This session provides methods to retrieve `Event` to `Calendar` mappings.
EventForm	This is the form for creating and updating `Events.`
EventList	Like all `OsidLists,` `EventList` provides a means for accessing `Event` elements sequentially either one at a time or many at a time.
EventLookupSession	This session provides methods for retrieving `Event` s.
EventNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to `Event` objects.
EventQuery	This is the query for searching events.
EventQueryInspector	This is the query inspector for examining event queries.
EventQuerySession	This session provides methods for searching `Event` objects.
EventReceiver	The event receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Events.`
EventSearch	`EventSearch` defines the interface for specifying event search options.
EventSearchOrder	An interface for specifying the ordering of search results.
EventSearchResults	This interface provides a means to capture results of a search.
EventSearchSession	This session provides methods for searching `Event` objects.
EventSmartCalendarSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
MeetingTime	An individual meeting time.
MeetingTimeList	Like all `OsidLists,` `MeetingTimeList` provides a means for accessing `MeetingTime` elements sequentially either one at a time or many at a time.
OffsetEvent	An `OffsetEvent` describes events that are relative to other events.
OffsetEventAdminSession	This session creates, updates, and deletes `Offset Events.`
OffsetEventCalendarAssignmentSession	This session provides methods to re-assign `OffsetEvents` to `Calendars.`
OffsetEventCalendarSession	This session provides methods to retrieve `OffsetEvent` to `Calendar` mappings.
OffsetEventForm	This is the form for creating and updating `OffsetEvents.`
OffsetEventList	Like all `OsidLists,` `OffsetEventList` provides a means for accessing `OffsetEvent` elements sequentially either one at a time or many at a time.
OffsetEventLookupSession	This session provides methods for retrieving `OffsetEvents.`
OffsetEventNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to `OffsetEvent` objects.
OffsetEventQuery	This is the query for searching events.
OffsetEventQueryInspector	This is the query inspector for examining offset event queries.
OffsetEventQuerySession	This session provides methods for searching `OffsetEvent` objects.
OffsetEventReceiver	The event receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `OffsetEvents.`
OffsetEventSearch	`OffsetEventSearch` defines the interface for specifying offset event search options.
OffsetEventSearchOrder	An interface for specifying the ordering of search results.
OffsetEventSearchResults	This interface provides a means to capture results of a search.
OffsetEventSearchSession	This session provides methods for searching `OffsetEvent` objects.
OffsetEventSmartCalendarSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
RecurringEvent	A `RecurringEvent` an event that repeats over a set of `Schedules,` other events, or custom rule.
RecurringEventAdminSession	This session creates, updates, and deletes `RecurringEvents.`
RecurringEventCalendarAssignmentSession	This session provides methods to re-assign `RecurringEvents` to `Calendars.`
RecurringEventCalendarSession	This session provides methods to retrieve `RecurringEvent` to `Calendar` mappings.
RecurringEventForm	This is the form for creating and updating `RecurringEvents.`
RecurringEventList	Like all `OsidLists,` `RecurringEventList` provides a means for accessing `RecurringEvent` elements sequentially either one at a time or many at a time.
RecurringEventLookupSession	This session provides methods for retrieving `RecurringEvent` s.
RecurringEventNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to `RecurringEvent` objects.
RecurringEventQuery	This is the query for searching recurring events.
RecurringEventQueryInspector	This is the query inspector for examining recurring event queries.
RecurringEventQuerySession	This session provides methods for searching `RecurringEvent` objects.
RecurringEventReceiver	The recurring event receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `RecurringEvents.`
RecurringEventSearch	`RecurringEventSearch` defines the interface for specifying recurring event search options.
RecurringEventSearchOrder	An interface for specifying the ordering of search results.
RecurringEventSearchResults	This interface provides a means to capture results of a search.
RecurringEventSearchSession	This session provides methods for searching `RecurringEvent` objects.
RecurringEventSmartCalendarSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
RecurringEventUnravellingSession	This session provides methods for retrieving and expanding `RecurringEvent` s.
Schedule	A `Schedule` is a scheduled time slot offered within a time interval at a location.
ScheduleAdminSession	This session creates, updates, and deletes `Schedules.`
ScheduleCalendarAssignmentSession	This session provides methods to re-assign `Schedules` to `Calendars.`
ScheduleCalendarSession	This session provides methods to retrieve `Schedule` to `Calendar` mappings.
ScheduleForm	This is the form for creating and updating `Schedules.`
ScheduleList	Like all `OsidLists,` `ScheduleList` provides a means for accessing `Schedule` elements sequentially either one at a time or many at a time.
ScheduleLookupSession	This session provides methods for retrieving `Schedules.`
ScheduleNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to `Schedule` objects.
ScheduleQuery	This is the query for searching schedules.
ScheduleQueryInspector	This is the query inspector for examining schedule queries.
ScheduleQuerySession	This session provides methods for searching `Schedule` objects.
ScheduleReceiver	The schedule receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `Schedules.`
ScheduleSearch	`ScheduleSearch` defines the interface for specifying schedule search options.
ScheduleSearchOrder	An interface for specifying the ordering of search results.
ScheduleSearchResults	This interface provides a means to capture results of a search.
ScheduleSearchSession	This session provides methods for searching `Schedule` objects.
ScheduleSlot	A `ScheduleSlot` describes a repeating time slot.
ScheduleSlotAdminSession	This session creates, updates, and deletes `Schedule Slots.`
ScheduleSlotCalendarAssignmentSession	This session provides methods to re-assign `ScheduleSlots` to `Calendars.`
ScheduleSlotCalendarSession	This session provides methods to retrieve `ScheduleSlot` to `Calendar` mappings.
ScheduleSlotForm	This is the form for creating and updating `ScheduleSlots.`
ScheduleSlotList	Like all `OsidLists,` `ScheduleSlotList` provides a means for accessing `ScheduleSlot` elements sequentially either one at a time or many at a time.
ScheduleSlotLookupSession	This session provides methods for retrieving `ScheduleSlots.`
ScheduleSlotNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to `ScheduleSlot` objects.
ScheduleSlotQuery	This is the query for searching schedule slots.
ScheduleSlotQueryInspector	This is the query inspector for examining schedule queries.
ScheduleSlotQuerySession	This session provides methods for searching `ScheduleSlot` objects.
ScheduleSlotReceiver	The schedule slot receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `ScheduleSlots.`
ScheduleSlotSearch	`ScheduleSlotSearch` defines the interface for specifying schedule slot search options.
ScheduleSlotSearchOrder	An interface for specifying the ordering of search results.
ScheduleSlotSearchResults	This interface provides a means to capture results of a search.
ScheduleSlotSearchSession	This session provides methods for searching `ScheduleSlot` objects.
ScheduleSlotSmartCalendarSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
ScheduleSmartCalendarSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
SupersedingEvent	A `SupersedingEvent` represents an override of an event such as an individual item in a recurring series.
SupersedingEventAdminSession	This session creates, updates, and deletes `Superseding Events.`
SupersedingEventCalendarAssignmentSession	This session provides methods to re-assign `SupersedingEvents` to `Calendars.`
SupersedingEventCalendarSession	This session provides methods to retrieve `SupersedingEvent` to `Calendar` mappings.
SupersedingEventForm	This is the form for creating and updating `SupersedingEvents.`
SupersedingEventList	Like all `OsidLists,` `SupersedingEventList` provides a means for accessing `SupersedingEvent` elements sequentially either one at a time or many at a time.
SupersedingEventLookupSession	This session provides methods for retrieving `SupersedingEvents.`
SupersedingEventNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to `SupersedingEvent` objects.
SupersedingEventQuery	This is the query for searching superseding events.
SupersedingEventQueryInspector	This is the query inspector for examining superseding event queries.
SupersedingEventQuerySession	This session provides methods for searching `SupersedingEvent` objects.
SupersedingEventReceiver	The superseding event receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `SupersedingEvents.`
SupersedingEventSearch	`SupersedingEventSearch` defines the interface for specifying superseding event search options.
SupersedingEventSearchOrder	An interface for specifying the ordering of search results.
SupersedingEventSearchResults	This interface provides a means to capture results of a search.
SupersedingEventSearchSession	This session provides methods for searching `SupersedingEvent` objects.
SupersedingEventSmartCalendarSession	This session manages queries and sequencing to create "smart" dynamic catalogs.
Time	The `Time` interface defines a time.
TimeList	Like all `OsidLists,` `TimeList` provides a means for accessing `Time` elements sequentially either one at a time or many at a time.
TimePeriod	A `TimePeriod` represents a span of time in which recurring events are expanded.
TimePeriodAdminSession	This session creates, updates, and deletes `Time Periods.`
TimePeriodCalendarAssignmentSession	This session provides methods to re-assign `TimePeriods` to `Calendars.`
TimePeriodCalendarSession	This session provides methods to retrieve `TimePeriod` to `Calendar` mappings.
TimePeriodForm	This is the form for creating and updating `TimePeriods.`
TimePeriodList	Like all `OsidLists,` `TimePeriodList` provides a means for accessing `TimePeriod` elements sequentially either one at a time or many at a time.
TimePeriodLookupSession	This session provides methods for retrieving `TimePeriod` objects.
TimePeriodNotificationSession	This session defines methods to receive asynchronous notifications on adds/changes to `TimePeriods.`
TimePeriodQuery	This is the query for searching time periods.
TimePeriodQueryInspector	This is the query inspector for examining time period queries.
TimePeriodQuerySession	This session provides methods for searching `TimePeriod` objects.
TimePeriodReceiver	The time period receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted `TimePeriods.`
TimePeriodSearch	`TimePeriodSearch` defines the interface for specifying time period search options.
TimePeriodSearchOrder	An interface for specifying the ordering of search results.
TimePeriodSearchResults	This interface provides a means to capture results of a search.
TimePeriodSearchSession	This session provides methods for searching `TimePeriod` objects.
TimePeriodSmartCalendarSession	This session manages queries and sequencing to create "smart" dynamic catalogs.

Enum Summary
Enum Description

DateTimeResolution
This enumeration contains the possible date/time resolutions.

Enum Summary
Enum	Description
DateTimeResolution	This enumeration contains the possible date/time resolutions.

Package org.osid.calendaring Description

The Open Service Interface Definitions for the org.osid.calendaring service.

The Calendaring OSID manages events, commitments and calendars. The Calendaring OSID offers a rich set of event management services.

Event

An Event is range of time associated with a Location and event sponsors. Events may be managed singularly, or be generated of of one of the typs of events listed below.

Offset Events

An OffSetEvent is an OsidRule for generating an Event off of another Event. An OffsetEvent may be offset by a fixed period of time, a weekday, or include an external Rule to determine the offset. Example OffsetEvents are "the first Tuesday after Labor Day" or "24 hours before a due date."

Superseding Events

A SupersedingEvent is an OsidRule for replacing another Event. Typically, SupersedingEvents are used for replacing a generated Event from a recurring event series. Events may be superseded by date or position in a recruring even seriest. Examples are "replace the event on 12/25 with an event scheduled for 12/26" or "replace the 10th event in a course schedule with an exam."

Recurring Events

A RecurringEvent generates a series of Events from a Schedule. A Schedule is a series of times and locations.

A RecurringEvent may include SupersedingEvents to replace specific events in the series with another Event which may, in turn, be another RecurringEvent. RecurringEvents may also have a set of blackout dates in which Event generation is suuppressed.

Schedules

A Schedule describes a repeating time and Location. Schedules may be bounded by dates or by using a TimePeriod. A TimePeriod is a reusable date range and may include a set of exception Events to define a set of time ranges that any RecurringEvent mapped to the TimePeriod may not occur.

Schedules are composed of ScheduleSlots. ScheduleSlots are normalized weekly time slots. A ScheduleSlot may be composed of other ScheduleSlots.

To make a RecurringEvent for MWF 3pm in room 26-100 during the summer except July 4th:

A ScheduleSlot for MWF 3pm is created.
A Schedule is created using the ScheduleSlot for room 10-250 in the summer TimePeriod.
A RecurringEvent is created using the Schedule.
A blackout date for Independence Day is added to the RecurringEvent.

Commitments

Commitments are OsidRelationships between Resources and Events. Commitments may include any data specific to the relationship.

Calendaring Catalogging

Events and Schedules are cataloged into Calendars. The Calendar is simply an OsidCatalog representing a collection of Events that may be federated using the OSID hierarchy pattern to create virtual calendars.

Calendaring Rules

The Calendaring OSID includes a rules package for managing the behavior of Commitments and Events. It also includes a Calendaring Cycle OSID for managing canonical events and time periods as well as a Calendaring Mason OSID for defining rules for building events and time periods. The Calendaring Batch OSID manages Events, Commitments, and TimePeriods in bulk.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may modify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.