OSID - osid.calendaring.SupersedingEvent Service Interface Definition

Interface	osid.calendaring.SupersedingEvent
Implements	`osid.OsidRule`
Description	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.
Method	getSupersededEventId
Description	Gets the event `Id` that is to be superseded.
Return	`osid.id.Id`		the superseding event `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getSupersededEvent
Description	Gets the event that is to be superseded.
Return	`osid.calendaring.Event`		the superseding event
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventId
Description	Gets the event `Id` that is superseding another.
Return	`osid.id.Id`		the superseding event `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEvent
Description	Gets the event that is superseding another.
Return	`osid.calendaring.Event`		the superseding event
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	supersedesByDate
Description	Tests if the superseding event replaces an event within a recurring series offered at a specific date/time. If `supersedesByDate()` is true, then `supersedesByPosition()` must be false.
Return	`boolean`		`true` if an event is superseded by date, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSupersededDate
Description	Gets the date of an event to replace if a recurring event is offered on that date.
Return	`osid.calendaring.DateTime`		the date of the event to replace
Errors	ILLEGAL_STATE		`supersedesByDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	supersedesByPosition
Description	Tests if the superseding event replaces an event within a recurring series identified by its denormalized position in the series. A negative number counts from the end of the series. If `supersedesByPosition()` is `true,` then `supersedesByDate()` must be `false.`
Return	`boolean`		`true` if an event is superseded by position, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSupersededEventPosition
Description	Gets the position in the denormalized recurring series of the event to replace. Positive numbers count from the start and negative numbers count from the end. Zero is invalid.
Return	`integer`		the position of the event to replace
Errors	ILLEGAL_STATE		`supersedesByPosition()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getSupersedingEventRecord
Description	Gets the superseding event record corresponding to the given `SupersedingEvent` record `Type.` This method is used to retrieve an object implementing the requested record. The `supersedingEventRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(supersedingEventRecordType)` is `true` .
Parameters	`osid.type.Type`	`supersedingEventRecordType`	the type of the record to retrieve
Return	`osid.calendaring.records.SupersedingEventRecord`		the superseding event record
Errors	NULL_ARGUMENT		`supersedingEventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(supersedingEventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.