OSID - osid.course.CourseForm Service Interface Definition

Interface	osid.course.CourseForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidOperableForm`
Implemented By	`osid.course.batch.CourseBatchForm`
Used By	`osid.course.CourseAdminSession`
Description	This is the form for creating and updating `Courses`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `CourseAdminSession`. 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	getSponsorsMetadata
Description	Gets the metadata for a set of 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[]`	`resourceIds`	the new sponsors
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	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	getCreditsMetadata
Description	Gets the metadata for the credits.
Return	`osid.Metadata`		metadata for the credit scale
Compliance	`mandatory`		This method must be implemented.
Method	setCredits
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	clearCredits
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 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 a 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 a set of grading options.
Return	`osid.Metadata`		metadata for the grading options
Compliance	`mandatory`		This method must be implemented.
Method	setGradingOptions
Description	Sets the grading options.
Parameters	`osid.id.Id[]`	`gradeSystemIds`	the new grade systems
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 obecjtives
Compliance	`mandatory`		This method must be implemented.
Method	setLearningObjectives
Description	Sets the learning objectives.
Parameters	`osid.id.Id[]`	`objectiveIds`	the new obejctives
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	getTargetAudiencesMetadata
Description	Gets the metadata for a set of target audiences.
Return	`osid.Metadata`		metadata for the target audiences
Compliance	`mandatory`		This method must be implemented.
Method	setTargetAudiences
Description	Sets the target audiences.
Parameters	`osid.id.Id[]`	`resourceIds`	the new target 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	clearTargetAudiences
Description	Removes the target audiences.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseFormRecord
Description	Gets the `CourseFormRecord` corresponding to the given course record `Type`.
Parameters	`osid.type.Type`	`courseRecordType`	a course record type
Return	`osid.course.records.CourseFormRecord`		the course form record
Errors	NULL_ARGUMENT		`courseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(courseRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.