OSID - osid.course.program.CourseProgramLookupSession Service Interface Definition

Interface	osid.course.program.CourseProgramLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving course program mappings. A `Course` maps to many `Programs` and a `Program` may be shared among multiple `Courses.` 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 lookup methods in this session operate, retrieve and pertain to courses and programs defined explicitly in the current course catalog. federated course catalog view: All lookup methods in this session operate, retrieve and pertain to all courses and programs defined in this course catalog and any other courses and programs implicitly available in this course catalog through course catalog inheritence. The methods `useFederatedCourseCatalogView()` and `useIsolatedCourseCatalogView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupCourseProgramMappings
Description	Tests if this user can perform `Course/Program` 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	useComparativeCourseProgramView
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	usePlenaryCourseProgramView
Description	A complete view of the lookups 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 and programs 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	getCoursesForProgram
Description	Gets a `CourseList` corresponding to the given `Program.` In plenary mode, the returned list contains all of the courses, or an error results if a course is not found or inaccessible. Otherwise, inaccessible `Courses` may be omitted from the list.
Parameters	`osid.id.IdList`	`programId`	a program `Id`
Return	`osid.course.CourseList`		the returned `Course` list
Errors	NOT_FOUND		`programId` not found
	NULL_ARGUMENT		`programId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramsForCourse
Description	Gets the `Programs` for the given `Course.` In plenary mode, the returned list contains all known programs or an error results. Otherwise, the returned list may contain only those programs that are accessible through this session.
Parameters	`osid.id.Id`	`courseId`	the `Id` of the `Course` to retrieve
Return	`osid.course.program.ProgramList`		the returned `Program` list
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.