OSID — Calendaring Entities

Event

Osid Object Containable

An Event represents a span of time and an optional location.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Temporal
`isEffective`	boolean		`true` if this is effective, `false` otherwise
`startDate`	datetime		the start date
`endDate`	datetime		the end date
Containable
`isSequestered`	boolean		`true` if this containable is sequestered, `false` if this containable may appear outside its aggregate

Name	Syntax	Many	Description
`isImplicit`	boolean		`true` if this event is implicit, `false` if explicitly defined
`isInRecurringSeries`	boolean		`true` if this event is part of a recurring series, `false` otherwise
`isSupersedingEvent`	boolean		`true` if this event is superseding event, `false` otherwise
`isOffsetEvent`	boolean		`true` if this event is an offset event, `false` otherwise
`locationDescription`	displaytext		the location
`hasLocation`	boolean		`true` if there is an associated location, `false` otherwise
`locationId`	id		a location `Id`
`location`	Location		a location
`hasSponsors`	boolean		`true` if there is an associated sponsor. `false` otherwise
`sponsorIds`	id	⋆	the sponsor `Ids`
`sponsors`	Resource	⋆	the sponsors

Recurring Event

Osid Rule Containable

A RecurringEvent an event that repeats over a set of Schedules, other events, or custom rule. The active status of the rule informs the appearance of recurring events as events.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise
OsidRule
`hasRule`	boolean		`true` if an explicit rule is available, `false` otherwise
`ruleId`	id		the rule `Id`
`rule`	Rule		the rule
`conditionRecordTypes`	type	⋆	a list of `OsidCondition` record `Types`
Containable
`isSequestered`	boolean		`true` if this containable is sequestered, `false` if this containable may appear outside its aggregate

Name	Syntax	Many	Description
`scheduleIds`	id	⋆	the recurring schedule `Ids`
`schedules`	Schedule	⋆	the recurring schedules
`supersedingEventIds`	id	⋆	list of superseding event `Ids`
`supersedingEvents`	SupersedingEvent	⋆	list of superseding events
`specificMeetingTimes`	MeetingTime	⋆	speciifc list of dates
`eventIds`	id	⋆	list of event `Ids`
`events`	Event	⋆	list of events
`blackouts`	DateTimeInterval	⋆	recurring event exceptions
`hasSponsors`	boolean		`true` if there is an associated sponsor. `false` otherwise
`sponsorIds`	id	⋆	the sponsor `Ids`
`sponsors`	Resource	⋆	the sponsors

Superseding Event

Osid Rule

A SupersedingEvent represents an override of an event such as an individual item in a recurring series. The event which is to supersede another must already be created. The SupersedingEvent rule causes the superseded Event to be overidden with the superseding Event at the superseding Event 's date and time.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise
OsidRule
`hasRule`	boolean		`true` if an explicit rule is available, `false` otherwise
`ruleId`	id		the rule `Id`
`rule`	Rule		the rule
`conditionRecordTypes`	type	⋆	a list of `OsidCondition` record `Types`

Name	Syntax	Description
`supersededEventId`	id	the superseding event `Id`
`supersededEvent`	Event	the superseding event
`supersedingEventId`	id	the superseding event `Id`
`supersedingEvent`	Event	the superseding event
`supersedesByDate`	boolean	`true` if an event is superseded by date, `false` otherwise
`supersededDate`	datetime	the date of the event to replace
`supersedesByPosition`	boolean	`true` if an event is superseded by position, `false` otherwise
`supersededEventPosition`	integer	the position of the event to replace

Offset Event

Osid Rule

An OffsetEvent describes events that are relative to other events. OffsetEvents may have a fixed or rubber start date as well as a fixed or rubber end date. A rubber start and end date has a variable duration based on the starting and ending milestones. An OffsetEvent with a fixed start date and a fixed duration behaves like a normal fixed Event.

Creating an OffsetEvent produces an Event that is based on these offset rules.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise
OsidRule
`hasRule`	boolean		`true` if an explicit rule is available, `false` otherwise
`ruleId`	id		the rule `Id`
`rule`	Rule		the rule
`conditionRecordTypes`	type	⋆	a list of `OsidCondition` record `Types`

Name	Syntax	Many	Description
`hasFixedStartTime`	boolean		`true` if this offset is based on a fixed start time, `false` otherwise
`fixedStartTime`	datetime		the fixed start time
`startReferenceEventId`	id		the relative event `Id`
`startReferenceEvent`	Event		the relative event
`hasFixedStartOffset`	boolean		`true` if this offset is based on a fixed period of time, `false` otherwise
`fixedStartOffset`	duration		the offset
`hasRelativeWeekdayStartOffset`	boolean		`true` if this offset is based on a relative weekday, `false` otherwise
`relativeWeekdayStartOffset`	integer		the offset
`relativeStartWeekday`	cardinal		the weekday number
`hasFixedDuration`	boolean		`true` if this offset is based on a fixed duration, `false` otherwise
`endReferenceEventId`	id		the relative event `Id`
`endReferenceEvent`	Event		the relative event
`hasFixedEndOffset`	boolean		`true` if this offset is based on a fixed period of time, `false` otherwise
`fixedEndOffset`	duration		the offset
`hasRelativeWeekdayEndOffset`	boolean		`true` if this offset is based on a relative weekday, `false` otherwise
`relativeWeekdayEndOffset`	integer		the offset
`relativeEndWeekday`	cardinal		the weekday number
`locationDescription`	displaytext		the location
`hasLocation`	boolean		`true` if there is an associated location, `false` otherwise
`locationId`	id		a location `Id`
`location`	Location		a location
`hasSponsors`	boolean		`true` if there is an associated sponsor. `false` otherwise
`sponsorIds`	id	⋆	the sponsor `Ids`
`sponsors`	Resource	⋆	the sponsors

Schedule

Osid Object

A Schedule is a scheduled time slot offered within a time interval at a location. The time interval may be inferred from an associated TimePeriod or managed explicitly without a TimePeriod.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object

Name	Syntax	Description
`scheduleSlotId`	id	the schedule slot `Id`
`scheduleSlot`	ScheduleSlot	the schedule slot
`hasTimePeriod`	boolean	`true` if there is an associated `TimePeriod`, `false` otherwise
`timePeriodId`	id	the time period `Id`
`timePeriod`	TimePeriod	the time period
`scheduleStart`	datetime	the start date
`scheduleEnd`	datetime	the end date
`hasLimit`	boolean	`true` if there is a limit `false` otherwise
`limit`	cardinal	the limit
`locationDescription`	displaytext	the location
`hasLocation`	boolean	`true` if there is an associated location, `false` otherwise
`locationId`	id	a location `Id`
`location`	Location	a location
`totalDuration`	duration	the total duration

Schedule Slot

Osid Object Containable

A ScheduleSlot describes a repeating time slot. The time slot can be defined as a fixed time interval or be defined on a weekly interval specifying the days of the week.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Containable
`isSequestered`	boolean		`true` if this containable is sequestered, `false` if this containable may appear outside its aggregate

Name	Syntax	Many	Description
`scheduleSlotIds`	id	⋆	the schedules slot `Ids`
`scheduleSlots`	ScheduleSlot	⋆	the schedule slots
`hasWeeklyInterval`	boolean		`true` if there is a weekly interval, `false` otherwise
`weekdays`	cardinal		the weekdays
`hasWeekOfMonthInterval`	boolean		`true` if there is a week of month specified, `false` otherwise
`weeklyInterval`	integer		`the week interval`
`weekOfMonth`	integer		`the week interval`
`weekdayTime`	Time		the time
`hasFixedInterval`	boolean		`true` if there is a fixed time interval, `false` otherwise
`fixedInterval`	duration		the interval
`duration`	duration		the duration

Time Period

Osid Object

A TimePeriod represents a span of time in which recurring events are expanded.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object

Name	Syntax	Many	Description
`start`	datetime		the start time
`end`	datetime		the end time
`exceptionIds`	id	⋆	list of exception event `Ids`
`exceptions`	Event	⋆	event exceptions

Commitment

Osid Relationship

A Commitment maps a Resource to an Event.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Temporal
`isEffective`	boolean		`true` if this is effective, `false` otherwise
`startDate`	datetime		the start date
`endDate`	datetime		the end date
OsidRelationship
`hasEndReason`	boolean		`true` if an end reason is available, `false` otherwise
`endReasonId`	id		a state `Id`
`endReason`	State		a state

Name	Syntax	Description
`eventId`	id	the event `Id`
`event`	Event	the event
`resourceId`	id	a resource `Id`
`resource`	Resource	the resource

Calendar

Osid Catalog

A calendar defines a collection of events.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Sourceable
`providerId`	id		the provider `Id`
`provider`	Resource		the provider
`brandingIds`	id	⋆	a list of asset `Ids`
`branding`	Asset	⋆	a list of assets
`license`	displaytext		the license

Calendaring

Event

Offset Events

Superseding Events

Recurring Events

Schedules

Commitments

Calendaring Catalogging

Calendaring Rules

Event

Recurring Event

Superseding Event

Offset Event

Schedule

Schedule Slot

Time Period

Commitment

Calendar