OSID - osid.course.Course Service Interface Definition

Interface	osid.course.Course
Implements	`osid.OsidObject`
Implements	`osid.Operable`
Used By	`osid.course.ActivityUnit`
	`osid.course.CourseAdminSession`
	`osid.course.CourseList`
	`osid.course.CourseLookupSession`
	`osid.course.CourseOffering`
	`osid.course.chronicle.AssessmentEntry`
	`osid.course.chronicle.AwardEntry`
	`osid.course.chronicle.CourseEntry`
	`osid.course.syllabus.Syllabus`
Description	A `Course` represents a canonical course that manages the curriculum of learning units. A `Course` is composed of `ActivityUnits` that manage the details of the curriculum and instantiated for offering through the creation of a `CourseOffering` .
Method	getTitle
Description	Gets the formal title of this course. It may be the same as the display name or it may be used to more formally label the course. A display name might be Physics 102 where the title is Introduction to Electromagentism.
Return	`osid.locale.DisplayText`		the course title
Compliance	`mandatory`		This method must be implemented.
Method	getNumber
Description	Gets the course number which is a label generally used to index the course in a catalog, such as T101 or 16.004.
Return	`string`		the course number
Compliance	`mandatory`		This method must be implemented.
Method	hasSponsors
Description	Tests if this course has sponsors.
Return	`boolean`		`true` if this course has sponsors, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSponsorIds
Description	Gets the sponsor `Ids`.
Return	`osid.id.IdList`		the sponsor `Ids`
Errors	ILLEGAL_STATE		`hasSponsors()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getSponsors
Description	Gets the sponsors.
Return	`osid.resource.ResourceList`		the sponsors
Errors	ILLEGAL_STATE		`hasSponsors()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCreditAmountIds
Description	Gets the credits in which this course can be offered. The credits are expressed as `Grades`.
Return	`osid.id.IdList`		the grade `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getCreditAmounts
Description	Gets the credits in which this course can be offered. The credits are expressed as `Grades`.
Return	`osid.grading.GradeList`		the credits
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getPrerequisitesInfo
Description	Gets the an informational text for the course prerequisites.
Return	`osid.locale.DisplayText`		the course prerequisites
Compliance	`mandatory`		This method must be implemented.
Method	hasPrerequisites
Description	Tests if this course has `Requisites` for the course prerequisites.
Return	`boolean`		`true` if this course has prerequisites `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPrerequisiteIds
Description	Gets the requisite `Ids` for the course prerequisites.
Return	`osid.id.IdList`		the requisite `Ids`
Errors	ILLEGAL_STATE		`hasPrerequisites()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getPrerequisites
Description	Gets the requisites for the course prerequisites. Each `Requisite` is an `AND` term such that all `Requisites` must be true for the prerequisites to be satisifed.
Return	`osid.course.requisite.RequisiteList`		the requisites
Errors	ILLEGAL_STATE		`hasPrerequisites()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getConcurrentCourseIds
Description	Gets the `Id` list of courses this `Course` must be taken concurrently.
Return	`osid.id.IdList`		the list of concurrent course `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getConcurrentCourses
Description	The list of `Courses` this `Course` must be taken concurrently. Courses which can be completed independently but allowed to be taken simultaneously is described using `Requisites`.
Return	`osid.course.CourseList`		the list of concurrent courses
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getLevelIds
Description	Gets the grade level `Ids` of this course. Multiple levels may exist for different systems.
Return	`osid.id.IdList`		the returned list of grade level `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getLevels
Description	Gets the grade levels of this course. Multiple levels may exist for different systems.
Return	`osid.grading.GradeList`		the returned list of grade levels
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isGraded
Description	Tests if this course is graded.
Return	`boolean`		`true` if this course is graded, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradingOptionIds
Description	Gets the various grading option `Ids` available to register in this course.
Return	`osid.id.IdList`		the returned list of grading option `Ids`
Errors	ILLEGAL_STATE		`isGraded()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getGradingOptions
Description	Gets the various grading options available to register in this course.
Return	`osid.grading.GradeSystemList`		the returned list of grading options
Errors	ILLEGAL_STATE		`isGraded()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasLearningObjectives
Description	Tests if this course has associated learning objectives.
Return	`boolean`		`true` if this course has a learning objective, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveIds
Description	Gets the overall learning objective `Ids` for this course.
Return	`osid.id.IdList`		`Ids` of the `l` earning objectives
Errors	ILLEGAL_STATE		`hasLearningObjectives()` is `false`
Compliance	`mandatory`		This method is must be implemented.
Method	getLearningObjectives
Description	Gets the overall learning objectives for this course.
Return	`osid.learning.ObjectiveList`		the learning objectives
Errors	ILLEGAL_STATE		`hasLearningObjectives()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasTargetAudiences
Description	Tests if this course has associated target audiences.
Return	`boolean`		`true` if this course has a target audience, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTargetAudienceIds
Description	Gets the target audience `Ids` for this course.
Return	`osid.id.IdList`		the target audience `Ids`
Errors	ILLEGAL_STATE		`hasTargetAudiences()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getTargetAudiences
Description	Gets the target audiences for this course.
Return	`osid.resource.ResourceList`		the target audiences
Errors	ILLEGAL_STATE		`hasTargetAudiences()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRecord
Description	Gets the course record corresponding to the given `Course` record `Type`.This method is used to retrieve an object implementing the requested record. The `courseRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(courseRecordType)` is `true`.
Parameters	`osid.type.Type`	`courseRecordType`	the type of course record to retrieve
Return	`osid.course.records.CourseRecord`		the course 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.