OSID - osid.calendaring.ScheduleSlot Service Interface Definition

Interface	osid.calendaring.ScheduleSlot
Implements	`osid.OsidObject`
Implements	`osid.Containable`
Used By	`osid.calendaring.Schedule`
	`osid.calendaring.ScheduleSlotAdminSession`
	`osid.calendaring.ScheduleSlotList`
	`osid.calendaring.ScheduleSlotLookupSession`
Description	A `ScheduleSlot` describes a repeating time slot. The time slot can be defined as a fixed time interval or be defined on a weekly interval specifying the days of the week.
Method	getScheduleSlotIds
Description	Gets the `Ids` of the schedule slots included inside this one.
Return	`osid.id.IdList`		the schedules slot `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlots
Description	Gets the schedule slots included inside this one.
Return	`osid.calendaring.ScheduleSlotList`		the schedule slots
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasWeeklyInterval
Description	Tests if this schedule has a weekly interval. If `true`, `hasFixedInterval()` must be `false`.
Return	`boolean`		`true` if there is a weekly interval, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWeekdays
Description	Gets the weekdays of the schedule. On a Gregorian calendar, Sunday is zero.
Return	`cardinal[]`		the weekdays
Errors	ILLEGAL_STATE		`hasWeeklyInterval()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasWeekOfMonthInterval
Description	Tests if this schedule has a weekly interval based on the week of the month. This method must be `false` if `hasWeeklyInterval()` is `false`.
Return	`boolean`		`true` if there is a week of month specified, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getWeeklyInterval
Description	Gets the number of weeks of the interval. 1 is every week. 2 is every other week. -1 is every week back in time.
Return	`integer`		`the week interval`
Errors	ILLEGAL_STATE		`hasWeekdlyInterval()` is `false` or `hasWeekofMonthInterval()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getWeekOfMonth
Description	Gets the week of the month for the interval. 1 is the first week of the month. -1 is the last week of the month. 0 is invalid.
Return	`integer`		`the week interval`
Errors	ILLEGAL_STATE		`hasWeeklyInterval()` is `false` or `hasWeekofMonthInterval()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getWeekdayTime
Description	Gets the time of this recurring schedule.
Return	`osid.calendaring.Time`		the time
Errors	ILLEGAL_STATE		`hasWeeklyInterval()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasFixedInterval
Description	Tests if this schedule has a fixed time interval.
Return	`boolean`		`true` if there is a fixed time interval, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getFixedInterval
Description	Gets the repeating interval.
Return	`osid.calendaring.Duration`		the interval
Errors	ILLEGAL_STATE		`hasFixedInterval()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getDuration
Description	Gets the duration of the schedule slot.
Return	`osid.calendaring.Duration`		the duration
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotRecord
Description	Gets the schedule slot record corresponding to the given `ScheduleSlot` record `Type`. This method is used to retrieve an object implementing the requested record. The `scheduleSlotRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(scheduleSlotRecordType)` is `true`.
Parameters	`osid.type.Type`	`scheduleSlotRecordType`	the type of the record to retrieve
Return	`osid.calendaring.records.ScheduleSlotRecord`		the schedule slot record
Errors	NULL_ARGUMENT		`scheduleSlotRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(scheduleSlotRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.