OSID - osid.course.registration.CourseRegistrationLookupSession Service Interface Definition

Interface	osid.course.registration.CourseRegistrationLookupSession
Implements	`osid.OsidSession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session provides methods for retrieving `CourseRegistrat` ions. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated course catalog view: All course registration methods in this session operate, retrieve and pertain to course registrations defined explicitly in the current course catalog Using an isolated view is useful for managing `CourseRegistra` tions with the `CourseRegistrationAdminSession` . federated course registration view: All course registration methods in this session operate, retrieve and pertain to all course registrations defined in this course catalog and any other course registrations implicitly available in this course catalog through course catalog inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. 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	canLookupCourseRegistrations
Description	Tests if this user can perform `CourseRegistr` ation 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 opt not to 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	useComparativeCourseRegistrationView
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	usePlenaryCourseRegistrationView
Description	A complete view of the `CourseRegistration` 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 registrations in course catalogs which are children of this course 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 lookups to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveCourseRegistrationView
Description	Only course registrations whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveCourseRegistrationView
Description	All course registrations of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCourseRegistration
Description	Gets the `CourseRegistr` ation specified by its `Id` . In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `CourseRegistr` ation may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `CourseRegistra` tion and retained for compatibility.
Parameters	`osid.id.Id`	`courseRegistrationId`	`Id` of the `CourseRegistration`
Return	`osid.course.registration.CourseRegistration`		the course registration
Errors	NOT_FOUND		`courseRegistrationId` not found
	NULL_ARGUMENT		`courseRegistrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCourseRegistrationsByIds
Description	Gets a `CourseRegistrationList` corresponding to the given `IdList` . In plenary mode, the returned list contains all of the course registrations 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 `CourseRegistratio` ns may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`courseRegistrationIds`	the list of `Ids` to retrieve
Return	`osid.course.registration.CourseRegistrationList`		the returned `CourseRegistration` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`courseRegistrationIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationsByGenusType
Description	Gets a `CourseRegistrationList` corresponding to the given course registration genus `Type` which does not include course registrations of genus types derived from the specified `Type` . In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those course registrations that are accessible through this session.
Parameters	`osid.type.Type`	`courseRegistrationGenusType`	a course registration genus type
Return	`osid.course.registration.CourseRegistrationList`		the returned `CourseRegistration` list
Errors	NULL_ARGUMENT		`courseRegistrationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationsByParentGenusType
Description	Gets a `CourseRegistrationList` corresponding to the given course registration genus `Type` and include any additional course registrations with genus types derived from the specified `Type` . In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those course registrations that are accessible through this session.
Parameters	`osid.type.Type`	`courseRegistrationGenusType`	a course registration genus type
Return	`osid.course.registration.CourseRegistrationList`		the returned `CourseRegistration` list
Errors	NULL_ARGUMENT		`courseRegistrationGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationsByRecordType
Description	Gets a `CourseRegistrationList` containing the given course registration record `Type` . In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those course registrations that are accessible through this session.
Parameters	`osid.type.Type`	`courseRegistrationRecordType`	a course registration record type
Return	`osid.course.registration.CourseRegistrationList`		the returned `CourseRegistration` list
Errors	NULL_ARGUMENT		`courseRegistrationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationsOnDate
Description	Gets all `CourseRegistrations` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, course registrations are returned that are currently effective. In any effective mode, effective course registrations and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.CourseRegistrationList`		a list of `CourseRegistrations`
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	getCourseRegistrationsForCourseOffering
Description	Gets all `CourseRegistrations` associated with a given `CourseOffering` . In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, course registrations are returned that are currently effective. In any effective mode, effective course registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Return	`osid.course.registration.CourseRegistrationList`		a list of `CourseRegistrations`
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationsForCourseOfferingOnDate
Description	Gets all `CourseRegistrations` for the given course offering and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, course registrations are returned that are currently effective. In any effective mode, effective course registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.CourseRegistrationList`		a list of `CourseRegistrations`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`courseOfferingId, from` , or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationsForStudent
Description	Gets all `CourseRegistrations` for a given student. In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, course registrations are returned that are currently effective. In any effective mode, effective course registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.course.registration.CourseRegistrationList`		a list of `CourseRegistrations`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationsForStudentOnDate
Description	Gets all `CourseRegistrations` for a student during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, course registrations are returned that are currently effective. In any effective mode, effective course registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.CourseRegistrationList`		a list of `CourseRegistrations`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from` , or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationsForCourseOfferingAndStudent
Description	Gets all `CourseRegistrations` for a given course offering and student. In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, course registrations are returned that are currently effective. In any effective mode, effective course registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.course.registration.CourseRegistrationList`		a list of `CourseRegistrations`
Errors	NULL_ARGUMENT		`courseOfferingId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationsForCourseOfferingAndStudentOnDate
Description	Gets all `CourseRegistrations` for a course offering and student during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those registrations that are accessible through this session. In effective mode, course registrations are returned that are currently effective. In any effective mode, effective course registrations and those currently expired are returned.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.registration.CourseRegistrationList`		a list of `CourseRegistrations`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`courseOfferingId, resourceId, from` , or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrations
Description	Gets all `CourseRegistrations` . In plenary mode, the returned list contains all known course registrations or an error results. Otherwise, the returned list may contain only those course registrations that are accessible through this session.
Return	`osid.course.registration.CourseRegistrationList`		a list of `CourseRegistrations`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.