OSID - osid.calendaring.Schedule Service Interface Definition

Interface	osid.calendaring.Schedule
Implements	`osid.OsidObject`
Description	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.`
Method	getScheduleSlotId
Description	Gets the `Id` of the schedule slot.
Return	`osid.id.Id`		the schedule slot `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlot
Description	Gets the schedule slot included inside this one.
Return	`osid.calendaring.ScheduleSlot`		the schedule slot
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasTimePeriod
Description	Tests if a `TimePeriod` is associated with this schedule. The time period determines the start and end time of the recurring series.
Return	`boolean`		`true` if there is an associated `TimePeriod,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriodId
Description	Gets the `TimePeriod Id` for this recurring event. A `Schedule` with an associated `TimePeriod` overrides any start or end date set.
Return	`osid.id.Id`		the time period `Id`
Errors	ILLEGAL_STATE		`hasTimePeriod()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getTimePeriod
Description	Gets the `TimePeriod` for this recurring event. A `Schedule` with an associated `TimePeriod` overrides any start or end date set.
Return	`osid.calendaring.TimePeriod`		the time period
Errors	ILLEGAL_STATE		`hasTimePeriod()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleStart
Description	Gets the start date of this schedule. If `hasTimePeriod()` is `true,` the start date is the start date of the associated `TimePeriod.`
Return	`osid.calendaring.DateTime`		the start date
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleEnd
Description	Gets the end date of this schedule. If `hasTimePeriod()` is `true,` the end date is the end date of the associated `TimePeriod.`
Return	`osid.calendaring.DateTime`		the end date
Compliance	`mandatory`		This method must be implemented.
Method	hasLimit
Description	Tests if this schedule has a limit on the number of occurrences.
Return	`boolean`		`true` if there is a limit `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLimit
Description	Gets the limit of the number of occurences of this schedule.
Return	`cardinal`		the limit
Errors	ILLEGAL_STATE		`hasLimitl()` 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	getTotalDuration
Description	Gets a total duration for the entire schedule based on the duration of schedule slots and span of the schedule.
Return	`osid.calendaring.Duration`		the total duration
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleRecord
Description	Gets the schedule record corresponding to the given `Schedule` record `Type.` This method is used to retrieve an object implementing the requested record. The `scheduleRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(scheduleRecordType)` is `true` .
Parameters	`osid.type.Type`	`scheduleRecordType`	the type of the record to retrieve
Return	`osid.calendaring.records.ScheduleRecord`		the schedule record
Errors	NULL_ARGUMENT		`scheduleRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(scheduleRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.