OSID - osid.course.CourseOffering Service Interface Definition

Interface	osid.course.CourseOffering
Implements	`osid.OsidRelationship`
Used By	`osid.course.Activity`
	`osid.course.CourseOfferingAdminSession`
	`osid.course.CourseOfferingList`
	`osid.course.CourseOfferingLookupSession`
	`osid.course.plan.Plan`
	`osid.course.registration.CourseRegistration`
	`osid.course.registration.RegistrationTarget`
Description	A `CourseOffering` represents a learning unit offered duing a `Term`. Scheduling information of a `CourseOffering` is maintained at the `Activity` level resulting in a composite `RecurringEvent`. A separate `Calendar` of activities can be made available through orchestration of the Calendaring OSID.
Method	getCourseId
Description	Gets the canonical course `Id` associated with this course offering.
Return	`osid.id.Id`		the course `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCourse
Description	Gets the canonical course associated with this course offering.
Return	`osid.course.Course`		the course
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTermId
Description	Gets the `Id` of the `Term` of this offering.
Return	`osid.id.Id`		the `Term` `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getTerm
Description	Gets the `Term` of this offering.
Return	`osid.course.Term`		the term
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
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 offering in a catalog, such as T101 or 16.004.
Return	`string`		the course number
Compliance	`mandatory`		This method must be implemented.
Method	getInstructorIds
Description	Gets the instructor `Ids`. If each activity has its own instructor, the headlining instructors may be returned.
Return	`osid.id.IdList`		the instructor `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getInstructors
Description	Gets the instructors. If each activity has its own instructor, the headlining instructors may be returned.
Return	`osid.resource.ResourceList`		the sponsors
Errors	OPERATION_FAILED		unable to complete request
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 registered. 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 registered. 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 offering has `Requisites` for the course prerequisites.
Return	`boolean`		`true` if this course offering 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 `CourseOffering` 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 `CourseOffering` 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 offering. 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 offering. 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 offering 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 offering has associated learning objectives.
Return	`boolean`		`true` if this course offering 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 offering.
Return	`osid.id.IdList`		`Ids` of the `l` earning objectives
Errors	ILLEGAL_STATE		`hasLearningObjectives()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectives
Description	Gets the overall learning objectives for this course offering.
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	hasRestrictedAudiences
Description	Tests if this course offering has restricted audiences.
Return	`boolean`		`true` if this course offering has a restricted audience, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRestrictedAudienceIds
Description	Gets the restricted audience `Ids` for this course offering.
Return	`osid.id.IdList`		the restricted audience `Ids`
Errors	ILLEGAL_STATE		`hasRestrictedAudiences()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRestrictedAudiences
Description	Gets the restricted audiences for this course offering.
Return	`osid.resource.ResourceList`		the restricted audiences
Errors	ILLEGAL_STATE		`hasRestrictedAudiences()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	requiresRegistration
Description	Tests if this course offering requires advanced registration.
Return	`boolean`		`true` if this course requires advance registration, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumSeats
Description	Gets the minimum number of students this offering can have.
Return	`cardinal`		the minimum seats
Compliance	`mandatory`		This method must be implemented.
Method	isSeatingLimited
Description	Tests if this course offering has limited seating.
Return	`boolean`		`true` if this seating is limited, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getMaximumSeats
Description	Gets the maximum number of students this offering can have.
Return	`cardinal`		the maximum seats
Errors	ILLEGAL_STATE		`isSeatingLimited()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getURL
Description	Gets an external resource, such as a class web site, associated with this offering.
Return	`string`		a URL string
Compliance	`mandatory`		This method must be implemented.
Method	getScheduleInfo
Description	Gets the an informational string for the course offering schedule.
Return	`osid.locale.DisplayText`		the schedule info
Compliance	`mandatory`		This method must be implemented.
Method	hasEvent
Description	Tests if a calendaring event is available for this course offering with the schedule details.
Return	`boolean`		`true` if this course is graded, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEventId
Description	Gets the calendaring event `Id`.
Return	`osid.id.Id`		the event `Id`
Errors	ILLEGAL_STATE		`hasEvent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getEvent
Description	Gets the calendaring event with the schedule details.
Return	`osid.calendaring.Event`		an event
Errors	ILLEGAL_STATE		`hasEvent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingRecord
Description	Gets the course offering record corresponding to the given `CourseOffering` record `Type` . This method is used to retrieve an object implementing the requested record. The `courseOfferingRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(courseOfferingRecordType)` is `true`.
Parameters	`osid.type.Type`	`courseOfferingRecordType`	the type of course offering record to retrieve
Return	`osid.course.records.CourseOfferingRecord`		the course offering 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.