OSID - osid.course.CourseLookupSession Service Interface Definition

Interface	osid.course.CourseLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving courses. A `Course` is a canonical course listed in a course catalog. A `CourseOffering` is derived from a `Course` and maps to an offering time and registered students. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated course catalog view: All course methods in this session operate, retrieve and pertain to courses defined explicitly in the current course catalog. Using an isolated view is useful for managing `Courses` with the `CourseAdminSession.` federated course catalog view: All course lookup methods in this session operate, retrieve and pertain to all courses defined in this course catalog and any other courses implicitly available in this course catalog through course catalog inheritence. active course view: All course lookup methods return courses which are active. any active course view: Courses of any active or inactive status are returned from methods. The methods `useFederatedCourseCatalogView()` and `useIsolatedCourseCatalogView()` behave as a radio group and one should be selected before invoking any lookup methods. Courses may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Course.`
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupCourses
Description	Tests if this user can perform `Course` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may not offer lookup operations to unauthorized users.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCourseView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryCourseView
Description	A complete view of the `Course` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include courses in catalogs which are children of this catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveCourseView
Description	Only active courses are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusCourseView
Description	All courses of any active or inactive status are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCourse
Description	Gets the `Course` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Course` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Course` and retained for compatibility. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the `Course` to retrieve
Return	`osid.course.Course`		the returned `Course`
Errors	NOT_FOUND		no `Course` found with the given `Id`
	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCoursesByIds
Description	Gets a `CourseList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the courses specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Courses` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
Parameters	`osid.id.IdList`	`courseIds`	the list of `Ids` to retrieve
Return	`osid.course.CourseList`		the returned `CourseList` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`courseIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCoursesByGenusType
Description	Gets a `CourseList` corresponding to the given course genus `Type` which does not include courses of types derived from the specified `Type.` In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
Parameters	`osid.type.Type`	`courseGenusType`	a course genus type
Return	`osid.course.CourseList`		the returned `CourseList` list
Errors	NULL_ARGUMENT		`courseGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCoursesByParentGenusType
Description	Gets a `CourseList` corresponding to the given course genus `Type` and include any additional courses with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
Parameters	`osid.type.Type`	`courseGenusType`	a course genus type
Return	`osid.course.CourseList`		the returned `CourseList` list
Errors	NULL_ARGUMENT		`courseGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCoursesByRecordType
Description	Gets a `CourseList` containing the given course record `Type.` In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
Parameters	`osid.type.Type`	`courseRecordType`	a course record type
Return	`osid.course.CourseList`		the returned `CourseList` list
Errors	NULL_ARGUMENT		`courseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCoursesByNumber
Description	Gets a `CourseList` by the given number. In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
Parameters	`string`	`number`	a course number
Return	`osid.course.CourseList`		the returned `CourseList` list
Errors	NULL_ARGUMENT		`number` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourses
Description	Gets all `Courses.` In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In active mode, courses are returned that are currently active. In any status mode, active and inactive courses are returned.
Return	`osid.course.CourseList`		a list of `Courses`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.