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

Interface	osid.course.program.EnrollmentNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Enrollment` objects in this `CourseCatalog.` This also includes existing enrollments that may appear or disappear due to changes in the `CourseCatalog` hierarchy, This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session is closed. The views defined in this session correspond to the views in the `EnrollmentLookupSession.`
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	canRegisterForEnrollmentNotifications
Description	Tests if this user can register for `Enrollment` notifications. 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 notification operations.
Return	`boolean`		`false` if notification methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method 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 notifications to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableEnrollmentNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeEnrollmentNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableEnrollmentNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeEnrollmentNotification
Description	Acknowledge an enrollment notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEnrollments
Description	Register for notifications of new enrollments. `EnrollmentReceiver.newEnrollments()` is invoked when a new `Enrollment` appears in this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEnrollmentsForProgramOffering
Description	Register for notifications of new enrollments for the given program offering. `EnrollmentReceiver.newEnrollments()` is invoked when a new `Enrollment` appears in this course catalog.
Parameters	`osid.id.Id`	`programOfferingId`	the `Id` of the `ProgramOffering` to monitor
Errors	NULL_ARGUMENT		`programOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewEnrollmentsForStudent
Description	Register for notifications of new enrollments for the given student. `EnrollmentReceiver.newEnrollments()` is invoked when a new `Enrollment` appears in this course catalog.
Parameters	`osid.id.Id`	`studentId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`studentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEnrollments
Description	Registers for notification of updated enrollments. `EnrollmentReceiver.changedEnrollments()` is invoked when an enrollment in this course catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEnrollmentsForProgramOffering
Description	Registers for notification of updated enrollments for the given program offering. `EnrollmentReceiver.changedEnrollments()` is invoked when an enrollment in this course catalog is changed.
Parameters	`osid.id.Id`	`programOfferingId`	the `Id` of the `ProgramOffering` to monitor
Errors	NULL_ARGUMENT		`programOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEnrollmentsForStudent
Description	Registers for notification of updated enrollments for the given student. `EnrollmentReceiver.changedEnrollments()` is invoked when a course in this course catalog is changed.
Parameters	`osid.id.Id`	`studentId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`studentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedEnrollment
Description	Registers for notification of an updated enrollment. `EnrollmentReceiver.changedEnrollments()` is invoked when the specified enrollment in this course catalog is changed.
Parameters	`osid.id.Id`	`enrollmentId`	the `Id` of the `Enrollment` to monitor
Errors	NULL_ARGUMENT		`enrollmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEnrollments
Description	Registers for notification of deleted enrollments. `EnrollmentReceiver.deletedEnrollments()` is invoked when an enrollment is deleted or removed from this course catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEnrollmentsForProgramOffering
Description	Registers for notification of deleted enrollments for the given program offering. `EnrollmentReceiver.deletedEnrollments()` is invoked when an enrollment is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`programOfferingId`	the `Id` of the `ProgramOffering` to monitor
Errors	NULL_ARGUMENT		`programOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEnrollmentsForStudent
Description	Registers for notification of deleted enrollments for the given student. `EnrollmentReceiver.deletedEnrollments()` is invoked when an enrollment is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`studentId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`studentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedEnrollment
Description	Registers for notification of a deleted enrollment. `EnrollmentReceiver.deletedEnrollments()` is invoked when the specified enrollment is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`enrollmentId`	the `Id` of the `Enrollment` to monitor
Errors	NULL_ARGUMENT		`enrollmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.