OSID Logo
OSID Specifications
calendaring package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.RecurringEvent
Implementsosid.OsidRule
osid.Containable
Description

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.

MethodgetScheduleIds
Description

Gets the Schedule Id of this composite event.

Returnosid.id.IdListthe recurring schedule Ids
CompliancemandatoryThis method must be implemented.
MethodgetSchedules
Description

Gets the recurring schedule in this composite event.

Returnosid.calendaring.ScheduleListthe recurring schedules
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEventIds
Description

Gets the superseding event Ids. A superseding event is one that replaces another in a series.

Returnosid.id.IdListlist of superseding event Ids
CompliancemandatoryThis method must be implemented.
MethodgetSupersedingEvents
Description

Gets the superseding events. A superseding event is one that replaces another in a series.

Returnosid.calendaring.SupersedingEventListlist of superseding events
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetSpecificMeetingTimes
Description

Gets specific dates for this event outside of the schedules. Specific dates are excluded from blackouts.

Returnosid.calendaring.MeetingTimeListspeciifc list of dates
CompliancemandatoryThis method must be implemented.
MethodgetEventIds
Description

Gets the composed event Ids.

Returnosid.id.IdListlist of event Ids
CompliancemandatoryThis method must be implemented.
MethodgetEvents
Description

Gets the composed events.

Returnosid.calendaring.EventListlist of events
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetBlackouts
Description

Gets the blackout dates for this recurring event. Recurring events overlapping with the time intervals do not appear in their series.

Returnosid.calendaring.DateTimeIntervalListrecurring event exceptions
CompliancemandatoryThis method must be implemented.
MethodhasSponsors
Description

Tests if a sponsor is associated with the overall recurring event.

Returnboolean true if there is an associated sponsor. false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetSponsorIds
Description

Gets the Id of the recurring event sponsors.

Returnosid.id.IdListthe sponsor Ids
ErrorsILLEGAL_STATE hasSponsors() is false
CompliancemandatoryThis method must be implemented.
MethodgetSponsors
Description

Gets the Sponsors.

Returnosid.resource.ResourceListthe sponsors
ErrorsILLEGAL_STATE hasSponsors() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRecurringEventRecord
Description

Gets the recurring event record corresponding to the given RecurringEvent record Type. This method is used to retrieve an object implementing the requested record. The recurringEventRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(recurringEventRecordType) is true .

Parametersosid.type.TyperecurringEventRecordTypethe type of the record to retrieve
Returnosid.calendaring.records.RecurringEventRecordthe recurring event record
ErrorsNULL_ARGUMENT recurringEventRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(recurringEventRecordType) is false
CompliancemandatoryThis method must be implemented.