OSID - osid.course.CourseOfferingLookupSession Service Interface Definition

Interface	osid.course.CourseOfferingLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving course offerings. A `CourseOffering` is a scheduled 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 offering methods in this session operate, retrieve and pertain to course offerings defined explicitly in the current course catalog. Using an isolated view is useful for managing `CourseOfferings` with the `CourseOfferingAdminSession.` federated course catalog view: All course offering lookup methods in this session operate, retrieve and pertain to all course offerings defined in this course catalog and any other courses implicitly available in this course catalog through course catalog inheritence. effective course offering view: All course offering lookup methods return course offerings where the current date falls within the effective dates inclusive. any effective course offering view: Course offerings of any effective or expired 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	canLookupCourseOfferings
Description	Tests if this user can perform `CourseOffering` 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	useComparativeCourseOfferingView
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	usePlenaryCourseOfferingView
Description	A complete view of the `CourseOffering` 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 course offerings 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	useEffectiveCourseOfferingView
Description	All course offering methods return course offerings where the current date falls within the effective dates inclusive.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveCourseOfferingView
Description	All methods return course offerings of any effective or expired status.
Compliance	`mandatory`		This method is must be implemented.
Method	getCourseOffering
Description	Gets the `CourseOffering` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `CourseOffering` 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 effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of the `CourseOffering` to retrieve
Return	`osid.course.CourseOffering`		the returned `CourseOffering`
Errors	NOT_FOUND		no `CourseOffering` found with the given `Id`
	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsByIds
Description	Gets a `CourseOfferingList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the course offerings 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 `CourseOfferings` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.id.IdList`	`courseOfferingIds`	the list of `Ids` to retrieve
Return	`osid.course.CourseOfferingList`		the returned `CourseOffering` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`courseOfferingIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsByGenusType
Description	Gets a `CourseOfferingList` corresponding to the given course offering genus `Type` which does not include course offerings of types derived from the specified `Type.` In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.type.Type`	`courseOfferingGenusType`	a course offering genus type
Return	`osid.course.CourseOfferingList`		the returned `CourseOffering` list
Errors	NULL_ARGUMENT		`courseOfferingGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsByParentGenusType
Description	Gets a `CourseOfferingList` corresponding to the given course genus `Type` and include any additional course offerings with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.type.Type`	`courseOfferingGenusType`	a course offering genus type
Return	`osid.course.CourseOfferingList`		the returned `CourseOffering` list
Errors	NULL_ARGUMENT		`courseOfferingGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsByRecordType
Description	Gets a `CourseOfferingList` containing the given course offering record `Type.` In plenary mode, the returned list contains all known courses or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.type.Type`	`courseOfferingRecordType`	a course offering record type
Return	`osid.course.CourseOfferingList`		the returned `CourseOffering` list
Errors	NULL_ARGUMENT		`courseOfferingRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsOnDate
Description	Gets all `CourseOfferings` effective within the given date range inclusive. In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.CourseOfferingList`		a list of `CourseOfferings`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsForCourse
Description	Gets all `CourseOfferings` associated with a given `Course.` In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.id.Id`	`courseId`	a course `Id`
Return	`osid.course.CourseOfferingList`		a list of `CourseOfferings`
Errors	NULL_ARGUMENT		`courseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsForCourseOnDate
Description	Gets all `CourseOffering` s for a course and effective within the given date range inclusive. In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.id.Id`	`courseId`	a course `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.CourseOfferingList`		a list of `CourseOfferings`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`courseId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsForTerm
Description	Gets all `CourseOfferings` associated for a given `Term.` In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Return	`osid.course.CourseOfferingList`		a list of `CourseOfferings`
Errors	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsForTermOnDate
Description	Gets all `CourseOfferings` for a term and effective within the given date range inclusive. In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.id.Id`	`termId`	a term `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.CourseOfferingList`		a list of `CourseOfferings`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`termId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsForCourseAndTerm
Description	Gets all `CourseOfferings` associated with a given `Term` and `Course.` In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.id.Id`	`courseId`	a course `Id`
Parameters	`osid.id.Id`	`termId`	a term `Id`
Return	`osid.course.CourseOfferingList`		a list of `CourseOfferings`
Errors	NULL_ARGUMENT		`courseId` or `termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsForCourseAndTermOnDate
Description	Gets all `CourseOffering` s for a course, term, and effective within the given date range inclusive. In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.id.Id`	`courseId`	a course `Id`
	`osid.id.Id`	`termId`	a term `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.CourseOfferingList`		a list of `CourseOfferings`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`courseId, termId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingsByNumberForTerm
Description	Gets all `CourseOfferings ny number and` associated with a given `Term.` In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those course offerings that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Parameters	`string`	`number`	a course offering number
Return	`osid.course.CourseOfferingList`		a list of `CourseOfferings`
Errors	NULL_ARGUMENT		`termId` or `number` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferings
Description	Gets all `CourseOfferings.` In plenary mode, the returned list contains all known course offerings or an error results. Otherwise, the returned list may contain only those courses that are accessible through this session. In effective mode, course offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired course offerings are returned.
Return	`osid.course.CourseOfferingList`		a list of `CourseOfferings`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.