OSID - osid.calendaring.ScheduleSlotForm Service Interface Definition

Interface	osid.calendaring.ScheduleSlotForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidContainableForm`
Implemented By	`osid.calendaring.batch.ScheduleSlotBatchForm`
Used By	`osid.calendaring.ScheduleSlotAdminSession`
Description	This is the form for creating and updating `ScheduleSlots`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `ScheduleSlotAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getWeekdayMetadata
Description	Gets the metadata for the weekdays of a weekly schedule.
Return	`osid.Metadata`		metadata for the weekday
Compliance	`mandatory`		This method must be implemented.
Method	setWeekdays
Description	Sets the weekdays of a weekly schedule.
Parameters	`cardinal[]`	`weekdays`	the new weekday set
Errors	INVALID_ARGUMENT		`weekdays` is invalid
	NO_ACCESS		`weekdays` cannot be modified
	NULL_ARGUMENT		`weekdays` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getWeeklyIntervalMetadata
Description	Gets the metadata for the interval of a weekly schedule.
Return	`osid.Metadata`		metadata for the weekly interval
Compliance	`mandatory`		This method must be implemented.
Method	setWeeklyInterval
Description	Sets the interval of a weekly schedule.
Parameters	`integer`	`interval`	the new weekly interval
Errors	INVALID_ARGUMENT		`interval` is invalid
Errors	NO_ACCESS		`interval` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	getWeekOfMonthMetadata
Description	Gets the metadata for the week of the month of a weekly schedule.
Return	`osid.Metadata`		metadata for the week of the month
Compliance	`mandatory`		This method must be implemented.
Method	setWeekOfMonth
Description	Sets the week of the month of a weekly schedule.
Parameters	`integer`	`week`	the new week of the month
Errors	INVALID_ARGUMENT		`week` is invalid
Errors	NO_ACCESS		`week` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	getWeekdayTimeMetadata
Description	Gets the metadata for the weekday time of a weekly schedule.
Return	`osid.Metadata`		metadata for the weekday time
Compliance	`mandatory`		This method must be implemented.
Method	setWeekdayTime
Description	Sets the weekday time of a weekly schedule.
Parameters	`osid.calendaring.Time`	`time`	the new time
Errors	INVALID_ARGUMENT		`time` is invalid
	NO_ACCESS		`time` cannot be modified
	NULL_ARGUMENT		`time` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearWeekdaySchedule
Description	Clears the weekday schedule items.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getFixedIntervalMetadata
Description	Gets the metadata for the fixed interval.
Return	`osid.Metadata`		metadata for the fixed interval.
Compliance	`mandatory`		This method must be implemented.
Method	setFixedInterval
Description	Sets the fixed interval.
Parameters	`osid.calendaring.Duration`	`interval`	the new fixed interval
Errors	INVALID_ARGUMENT		`interval` is invalid
	NO_ACCESS		`interval` cannot be modified
	NULL_ARGUMENT		`interval` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearFixedInterval
Description	Clears the fixed interval items.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getDurationMetadata
Description	Gets the metadata for the duration of the slot.
Return	`osid.Metadata`		metadata for the duration
Compliance	`mandatory`		This method must be implemented.
Method	setDuration
Description	Sets the duration.
Parameters	`osid.calendaring.Duration`	`duration`	the new duration
Errors	INVALID_ARGUMENT		`duration` is invalid
	NO_ACCESS		`duration` cannot be modified
	NULL_ARGUMENT		`duration` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDuration
Description	Clears the duration terms.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleSlotFormRecord
Description	Gets the `ScheduleSlotFormRecord` corresponding to the given schedule record `Type`.
Parameters	`osid.type.Type`	`scheduleSlotRecordType`	the schedule slot record type
Return	`osid.calendaring.records.ScheduleSlotFormRecord`		the schedule slot form 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.