OSID - osid.course.CourseOfferingForm Service Interface Definition

Interface	osid.course.CourseOfferingForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.course.batch.CourseOfferingBatchForm`
Used By	`osid.course.CourseOfferingAdminSession`
Description	This is the form for creating and updating `CourseOfferings`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `CourseOfferingAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTitleMetadata
Description	Gets the metadata for a course title.
Return	`osid.Metadata`		metadata for the title
Compliance	`mandatory`		This method must be implemented.
Method	setTitle
Description	Sets the title.
Parameters	`string`	`title`	the new title
Errors	INVALID_ARGUMENT		`title` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`title` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTitle
Description	Removes the title.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getNumberMetadata
Description	Gets the metadata for a course number.
Return	`osid.Metadata`		metadata for the course number
Compliance	`mandatory`		This method must be implemented.
Method	setNumber
Description	Sets the course number.
Parameters	`string`	`number`	the new course number
Errors	INVALID_ARGUMENT		`number` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`number` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearNumber
Description	Removes the course number.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getInstructorsMetadata
Description	Gets the metadata for the instructors.
Return	`osid.Metadata`		metadata for the instructors
Compliance	`mandatory`		This method must be implemented.
Method	setInstructors
Description	Sets the instructors.
Parameters	`osid.id.Id[]`	`resourceIds`	the new instructors
Errors	INVALID_ARGUMENT		`instructorIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`instructorIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInstructors
Description	Removes the instructors.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSponsorsMetadata
Description	Gets the metadata for the sponsors.
Return	`osid.Metadata`		metadata for the sponsors
Compliance	`mandatory`		This method must be implemented.
Method	setSponsors
Description	Sets the sponsors.
Parameters	`osid.id.Id[]`	`sponsorIds`	the new sponsors
Errors	INVALID_ARGUMENT		`sponsorIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`sponsorIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSponsors
Description	Removes the sponsors.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCreditAmountsMetadata
Description	Gets the metadata for the credits.
Return	`osid.Metadata`		metadata for the credit scale
Compliance	`mandatory`		This method must be implemented.
Method	setCreditAmounts
Description	Sets the credits.
Parameters	`osid.id.Id[]`	`gradeIds`	the new credit levels
Errors	INVALID_ARGUMENT		`gradeIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`gradeIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditAmounts
Description	Removes the credits.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPrerequisitesInfoMetadata
Description	Gets the metadata for a course offering prerequisite informational string.
Return	`osid.Metadata`		metadata for the prerequisite information
Compliance	`mandatory`		This method must be implemented.
Method	setPrerequisitesInfo
Description	Sets the prerequisitie information.
Parameters	`string`	`prereqInfo`	the new prerequisite information
Errors	INVALID_ARGUMENT		`prereqInfo` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`prereqInfo` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPrerequisitesInfo
Description	Removes the prerequisite information.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPrerequisitesMetadata
Description	Gets the metadata for prerequisites.
Return	`osid.Metadata`		metadata for the requisites
Compliance	`mandatory`		This method must be implemented.
Method	setPrerequisites
Description	Sets the prerequisites.
Parameters	`osid.id.Id[]`	`requisiteIds`	the new requisites
Errors	INVALID_ARGUMENT		`requisiteIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`requisiteIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPrerequisites
Description	Removes the prerequisites.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLevelsMetadata
Description	Gets the metadata for a set of grade levels.
Return	`osid.Metadata`		metadata for the levels
Compliance	`mandatory`		This method must be implemented.
Method	setLevels
Description	Sets the levels.
Parameters	`osid.id.Id[]`	`gradeIds`	the new grade levels
Errors	INVALID_ARGUMENT		`gradeIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`gradeIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLevels
Description	Removes the grade levels.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGradingOptionsMetadata
Description	Gets the metadata for the grading options.
Return	`osid.Metadata`		metadata for the prerequisite information
Compliance	`mandatory`		This method must be implemented.
Method	setGradingOptions
Description	Sets the grading options.
Parameters	`osid.id.Id[]`	`gradeSystemIds`	the new grading options
Errors	INVALID_ARGUMENT		`gradeSystemIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`gradeSystemIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGradingOptions
Description	Removes the grading options.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectivesMetadata
Description	Gets the metadata for a set of learning objectives.
Return	`osid.Metadata`		metadata for the objectives
Compliance	`mandatory`		This method must be implemented.
Method	setLearningObjectives
Description	Sets the learning objectives.
Parameters	`osid.id.Id[]`	`objectiveIds`	the new objectives
Errors	INVALID_ARGUMENT		`objectiveIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`objectiveIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectives
Description	Removes the learning objectives.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRestrictedAudiencesMetadata
Description	Gets the metadata for a set of restricted audiences.
Return	`osid.Metadata`		metadata for the restricted audiences
Compliance	`mandatory`		This method must be implemented.
Method	setRestrictedAudiences
Description	Sets the restricted audiences.
Parameters	`osid.id.Id[]`	`resourceIds`	the new restricted audiences
Errors	INVALID_ARGUMENT		`resourceIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`resourceIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRestrictedAudiences
Description	Removes the restricted audiences.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRequiresRegistrationMetadata
Description	Gets the metadata for requires registration flag.
Return	`osid.Metadata`		metadata for registration flag
Compliance	`mandatory`		This method must be implemented.
Method	setRequiresRegistration
Description	Sets the requires registration flag.
Parameters	`boolean`	`requiresRegistration`	the new registration flag
Errors	INVALID_ARGUMENT		`requiresRegistration` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresRegistration
Description	Removes the requires registration flag.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumSeatsMetadata
Description	Gets the metadata for the minimum seats.
Return	`osid.Metadata`		metadata for the minimum seats
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumSeats
Description	Sets the minimum seating count.
Parameters	`cardinal`	`seats`	the new minimum seats
Errors	INVALID_ARGUMENT		`seats` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumSeats
Description	Removes the minimum seats.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMaximumSeatsMetadata
Description	Gets the metadata for the maximum seats.
Return	`osid.Metadata`		metadata for the maximum seats
Compliance	`mandatory`		This method must be implemented.
Method	setMaximumSeats
Description	Sets the maximum seating count.
Parameters	`cardinal`	`seats`	the new maximum seats
Errors	INVALID_ARGUMENT		`seats` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMaximumSeats
Description	Removes the maximum seats.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getURLMetadata
Description	Gets the metadata for a class url.
Return	`osid.Metadata`		metadata for the url
Compliance	`mandatory`		This method must be implemented.
Method	setURL
Description	Sets the url for a class web site.
Parameters	`string`	`url`	the new url
Errors	INVALID_ARGUMENT		`url` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`url` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearURL
Description	Removes the url.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleInfoMetadata
Description	Gets the metadata for a schedule informatoin string.
Return	`osid.Metadata`		metadata for the schedule information
Compliance	`mandatory`		This method must be implemented.
Method	setScheduleInfo
Description	Sets the schedule information. This information may be derived from the schedule and not settable here.
Parameters	`string`	`scheduleInfo`	the new schedule info
Errors	INVALID_ARGUMENT		`scheduleInfo` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`scheduleInfo` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearScheduleInfo
Description	Removes the schedule info.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEventMetadata
Description	Gets the metadata for manually linking an event.
Return	`osid.Metadata`		metadata for the event
Compliance	`mandatory`		This method must be implemented.
Method	setEvent
Description	Sets the event. This information may be derived from the activity schedules.
Parameters	`osid.id.Id`	`eventId`	the new event
Errors	INVALID_ARGUMENT		`eventId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`eventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEvent
Description	Removes the event.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingFormRecord
Description	Gets the `CourseOfferingFormRecord` corresponding to the given course offering record `Type`.
Parameters	`osid.type.Type`	`courseOfferingRecordType`	a course offering record type
Return	`osid.course.records.CourseOfferingFormRecord`		the course offering form record
Errors	NULL_ARGUMENT		`courseOfferingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(courseOfferingRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.