OSID - osid.calendaring.RecurringEvent Service Interface Definition

Interface	osid.calendaring.RecurringEvent
Implements	`osid.OsidRule`
Implements	`osid.Containable`
Used By	`osid.calendaring.RecurringEventAdminSession`
	`osid.calendaring.RecurringEventList`
	`osid.calendaring.RecurringEventLookupSession`
	`osid.calendaring.RecurringEventUnravellingSession`
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.
Method	getScheduleIds
Description	Gets the `Schedule Id` of this composite event.
Return	`osid.id.IdList`		the recurring schedule `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getSchedules
Description	Gets the recurring schedule in this composite event.
Return	`osid.calendaring.ScheduleList`		the recurring schedules
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventIds
Description	Gets the superseding event `Ids`. A superseding event is one that replaces another in a series.
Return	`osid.id.IdList`		list of superseding event `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEvents
Description	Gets the superseding events. A superseding event is one that replaces another in a series.
Return	`osid.calendaring.SupersedingEventList`		list of superseding events
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSpecificMeetingTimes
Description	Gets specific dates for this event outside of the schedules. Specific dates are excluded from blackouts.
Return	`osid.calendaring.MeetingTimeList`		speciifc list of dates
Compliance	`mandatory`		This method must be implemented.
Method	getEventIds
Description	Gets the composed event `Ids`.
Return	`osid.id.IdList`		list of event `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getEvents
Description	Gets the composed events.
Return	`osid.calendaring.EventList`		list of events
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getBlackouts
Description	Gets the blackout dates for this recurring event. Recurring events overlapping with the time intervals do not appear in their series.
Return	`osid.calendaring.DateTimeIntervalList`		recurring event exceptions
Compliance	`mandatory`		This method must be implemented.
Method	hasSponsors
Description	Tests if a sponsor is associated with the overall recurring event.
Return	`boolean`		`true` if there is an associated sponsor. `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSponsorIds
Description	Gets the `Id` of the recurring event sponsors.
Return	`osid.id.IdList`		the sponsor `Ids`
Errors	ILLEGAL_STATE		`hasSponsors()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getSponsors
Description	Gets the `Sponsors`.
Return	`osid.resource.ResourceList`		the sponsors
Errors	ILLEGAL_STATE		`hasSponsors()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getRecurringEventRecord
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`.
Parameters	`osid.type.Type`	`recurringEventRecordType`	the type of the record to retrieve
Return	`osid.calendaring.records.RecurringEventRecord`		the recurring event record
Errors	NULL_ARGUMENT		`recurringEventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(recurringEventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.