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

Interface	osid.course.program.EnrollmentLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving enrollments. An `Enrollment` is a relationship between a student and an `ProgramOffering.` 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 enrollment methods in this session operate, retrieve and pertain to enrollments defined explicitly in the current course catalog. Using an isolated view is useful for managing `Enrollments` with the `EnrollmentAdminSession.` federated course catalog view: All enrollment lookup methods in this session operate, retrieve and pertain to all enrollments defined in this course catalog and any other enrollments implicitly available in this course catalog through course catalog inheritence. effective vote view: All enrollment lookup methods return enrollments where the current date falls in between the effective dates inclusive. any effective vote view: enrollments of any effective date are returned from methods. The methods `useFederatedCourseCatalogView()` and `useIsolatedCourseCatalogView()` behave as a radio group and one should be selected before invoking any lookup methods. Enrollments may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Enrollment.`
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	canLookupEnrollments
Description	Tests if this user can perform `Enrollment` 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	useComparativeEnrollmentView
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	usePlenaryEnrollmentView
Description	A complete view of the `Enrollment` 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 enrollments 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	useEffectiveEnrollmentView
Description	Only enrollments whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveEnrollmentView
Description	All enrollments of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getEnrollment
Description	Gets the `Enrollment` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Enrollment` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Enrollment` and retained for compatibility. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.Id`	`enrollmentId`	the `Id` of the `Enrollment` to retrieve
Return	`osid.course.program.Enrollment`		the returned `Enrollment`
Errors	NOT_FOUND		no `Enrollment` found with the given `Id`
	NULL_ARGUMENT		`enrollmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsByIds
Description	Gets an `EnrollmentList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the enrollments 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 `Enrollments` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.IdList`	`enrollmentIds`	the list of `Ids` to retrieve
Return	`osid.course.program.EnrollmentList`		the returned `Enrollment` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`enrollmentIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsByGenusType
Description	Gets an `EnrollmentList` corresponding to the given enrollment genus `Type` which does not include enrollments of types derived from the specified `Type.` In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.type.Type`	`enrollmentGenusType`	an enrollment genus type
Return	`osid.course.program.EnrollmentList`		the returned `Enrollment` list
Errors	NULL_ARGUMENT		`enrollmentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsByParentGenusType
Description	Gets an `EnrollmentList` corresponding to the given course genus `Type` and include any additional enrollments with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.type.Type`	`enrollmentGenusType`	an enrollment genus type
Return	`osid.course.program.EnrollmentList`		the returned `Enrollment` list
Errors	NULL_ARGUMENT		`enrollmentGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsByRecordType
Description	Gets an `EnrollmentList` containing the given enrollment record `Type.` In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.type.Type`	`enrollmentRecordType`	an enrollment record type
Return	`osid.course.program.EnrollmentList`		the returned `Enrollment` list
Errors	NULL_ARGUMENT		`enrollmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsOnDate
Description	Gets all `Enrollments` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments 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.program.EnrollmentList`		a list of `Enrollments`
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	getEnrollmentsForProgramOffering
Description	Gets all `Enrollments` associated with a given `ProgramOffering.` In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.Id`	`programOfferingId`	a program offering `Id`
Return	`osid.course.program.EnrollmentList`		a list of `Enrollments`
Errors	NULL_ARGUMENT		`programOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsForProgramOfferingOnDate
Description	Gets all `Enrollments` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.Id`	`programOfferingId`	a program offering `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.program.EnrollmentList`		a list of `Enrollments`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`programOfferingId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsForStudent
Description	Gets all `Enrollments` for a given student. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.course.program.EnrollmentList`		a list of `Enrollments`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsForStudentOnDate
Description	Gets all `Enrollments` 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 enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments 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.program.EnrollmentList`		a list of `Enrollments`
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	getEnrollmentsForProgramOfferingAndStudent
Description	Gets all `Enrollments` for a given program offering and student. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.Id`	`programOfferingId`	a program offering `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.course.program.EnrollmentList`		a list of `Enrollments`
Errors	NULL_ARGUMENT		`programOfferingId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsForProgramOfferingAndStudentOnDate
Description	Gets all `Enrollments` for a program offering and student effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.Id`	`programOfferingId`	a program 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.program.EnrollmentList`		a list of `Enrollments`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`programOfferingId, resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsForProgram
Description	Gets all `Enrollments` related to a program. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.Id`	`programId`	a program `Id`
Return	`osid.course.program.EnrollmentList`		a list of `Enrollments`
Errors	NULL_ARGUMENT		`programId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsForProgramOnDate
Description	Gets all `Enrollments` for a program effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.Id`	`programId`	a program `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.course.program.EnrollmentList`		a list of `Enrollments`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`programId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsForProgramAndStudent
Description	Gets all `Enrollments` for a given program and student. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.Id`	`programId`	a program `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.course.program.EnrollmentList`		a list of `Enrollments`
Errors	NULL_ARGUMENT		`programId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentsForProgramAndStudentOnDate
Description	Gets all `Enrollments` for a program and student effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Parameters	`osid.id.Id`	`programId`	a program `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.program.EnrollmentList`		a list of `Enrollments`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`programId, resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollments
Description	Gets all `Enrollments.` In plenary mode, the returned list contains all known enrollments or an error results. Otherwise, the returned list may contain only those enrollments that are accessible through this session. In effective mode, enrollments are returned that are currently effective. In any effective mode, effective enrollments and those currently expired are returned.
Return	`osid.course.program.EnrollmentList`		a list of `Enrollments`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.