OSID - osid.calendaring.OffsetEvent Service Interface Definition

Interface	osid.calendaring.OffsetEvent
Implements	`osid.OsidRule`
Used By	`osid.calendaring.OffsetEventAdminSession`
	`osid.calendaring.OffsetEventList`
	`osid.calendaring.OffsetEventLookupSession`
Description	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.
Method	hasFixedStartTime
Description	Tests if this offset event is based on a fixed start time.
Return	`boolean`		`true` if this offset is based on a fixed start time, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFixedStartTime
Description	Gets the fixed start time for this event.
Return	`osid.calendaring.DateTime`		the fixed start time
Errors	ILLEGAL_STATE		`hasFixedStartIme()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getStartReferenceEventId
Description	Gets the `Event Id` to which the start of this event is offset.
Return	`osid.id.Id`		the relative event `Id`
Errors	ILLEGAL_STATE		`hasFixedStartTime()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getStartReferenceEvent
Description	Gets the `Event` to which the start of this event is offset.
Return	`osid.calendaring.Event`		the relative event
Errors	ILLEGAL_STATE		`hasFixedStartTime()` is `true`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasFixedStartOffset
Description	Tests if this offset start time based on a fixed period of time.
Return	`boolean`		`true` if this offset is based on a fixed period of time, `false` otherwise
Errors	ILLEGAL_STATE		`hasFixedStartTime()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getFixedStartOffset
Description	Gets the fixed starting time offset.
Return	`osid.calendaring.Duration`		the offset
Errors	ILLEGAL_STATE		`hasFixedStartOffset()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasRelativeWeekdayStartOffset
Description	Tests if this starting time offset is a based on a relative weekday.
Return	`boolean`		`true` if this offset is based on a relative weekday, `false` otherwise
Errors	ILLEGAL_STATE		`hasFixedStartOffset()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRelativeWeekdayStartOffset
Description	Gets the starting offset as the nth weekday from the relative event. Zero is no offset.
Return	`integer`		the offset
Errors	ILLEGAL_STATE		`hasRelativeWeekdayStartOffset()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRelativeStartWeekday
Description	Gets the starting weekday number. The weekday is based on the calendar type. On the Gregorian calendar, 0 is Sunday.
Return	`cardinal`		the weekday number
Errors	ILLEGAL_STATE		`hasRelativeWeekdayStartOffset()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasFixedDuration
Description	Tests if this offset event is based on a fixed duration.
Return	`boolean`		`true` if this offset is based on a fixed duration, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFixedDuration
Description	Gets the duration of the offset event.
Parameters	`osid.calendaring.DateTimeResolution`	`units`	the units of the duration
Return	`osid.calendaring.Duration`		the duration
Errors	ILLEGAL_STATE		`hasFixedDuration()` is `false`
Errors	NULL_ARGUMENT		`units` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getEndReferenceEventId
Description	Gets the `Event Id` to which the end of this event is offset.
Return	`osid.id.Id`		the relative event `Id`
Errors	ILLEGAL_STATE		`hasFixedDuration()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEndReferenceEvent
Description	Gets the `Event` to which the end of this event is offset.
Return	`osid.calendaring.Event`		the relative event
Errors	ILLEGAL_STATE		`hasFixedDuration()` is `true`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasFixedEndOffset
Description	Tests if this offset end time based on a fixed period of time.
Return	`boolean`		`true` if this offset is based on a fixed period of time, `false` otherwise
Errors	ILLEGAL_STATE		`hasFixedDuration()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getFixedEndOffset
Description	Gets the fixed ending time offset.
Return	`osid.calendaring.Duration`		the offset
Errors	ILLEGAL_STATE		`hasFixedEndOffset()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasRelativeWeekdayEndOffset
Description	Tests if this ending time offset is a based on a relative weekday.
Return	`boolean`		`true` if this offset is based on a relative weekday, `false` otherwise
Errors	ILLEGAL_STATE		`hasFixedEndOffset()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRelativeWeekdayEndOffset
Description	Gets the ending offset as the nth weekday from the relative event. Zero is no offset.
Return	`integer`		the offset
Errors	ILLEGAL_STATE		`hasRelativeWeekdayEndOffset()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRelativeEndWeekday
Description	Gets the ending weekday number. The weekday is based on the calendar type. On the Gregorian calendar, 0 is Sunday.
Return	`cardinal`		the weekday number
Errors	ILLEGAL_STATE		`hasRelativeWeekdayEndOffset()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getLocationDescription
Description	Gets a descriptive location.
Return	`osid.locale.DisplayText`		the location
Compliance	`mandatory`		This method must be implemented.
Method	hasLocation
Description	Tests if a location is associated with this event.
Return	`boolean`		`true` if there is an associated location, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLocationId
Description	Gets the location `Id`.
Return	`osid.id.Id`		a location `Id`
Errors	ILLEGAL_STATE		`hasLocation()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getLocation
Description	Gets the `Location`.
Return	`osid.mapping.Location`		a location
Errors	ILLEGAL_STATE		`hasLocation()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasSponsors
Description	Tests if a sponsor is associated with this 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 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	getOffsetEventRecord
Description	Gets the offset event record corresponding to the given `OffsetEvent` record `Type`. This method is used to retrieve an object implementing the requested record. The `offsetEventRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(offsetEventRecordType)` is `true`.
Parameters	`osid.type.Type`	`offsetEventRecordType`	the type of the record to retrieve
Return	`osid.calendaring.records.OffsetEventRecord`		the offset event record
Errors	NULL_ARGUMENT		`offsetEventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(offsetEventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.