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

Interface	osid.course.registration.CourseRegistrationNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.course.registration.CourseRegistrationManager`
Used By	`osid.course.registration.CourseRegistrationProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `CourseRegistra` tions in this `CourseCatalog`. This also includes existing course registrations 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 two views defined in this session correspond to the views in the `CourseRegistrationLookupSessi` on.
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	canRegisterForCourseRegistrationNotifications
Description	Tests if this user can register for `CourseRegistr` ation 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 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 notifications to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableCourseRegistrationNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCourseRegistrationNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCourseRegistrationNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCourseRegistrationNotification
Description	Acknowledge a course registration 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	registerForNewCourseRegistrations
Description	Register for notifications of new course registrations. `CourseRegistrationReceiver.newCourseRegistrations()` is invoked when a new `CourseRegistration` 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	registerForNewCourseRegistrationsForRegistration
Description	Register for notifications of new course registrations for the given registration. `CourseRegistrationReceiver.newCourseRegistrations()` is invoked when a new `CourseRegistration` appears in this course catalog.
Parameters	`osid.id.Id`	`registrationId`	the `Id` of the `Registration` to monitor
Errors	NULL_ARGUMENT		`registrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCourseRegistrationsForCourseOffering
Description	Register for notifications of new course registrations for the given course offering. `CourseRegistrationReceiver.newCourseRegistrations()` is invoked when a new `CourseRegistration` appears in this course catalog.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of the `CourseOffering` to monitor
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewCourseRegistrationsForStudent
Description	Register for notifications of new course registrations for the given student. `CourseRegistrationReceiver.newCourseRegistrations()` is invoked when a new `CourseRegistration` appears in this course catalog.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCourseRegistrations
Description	Register for notifications of updated course registrations. `CourseRegistrationReceiver.changedCourseRegistrations()` is invoked when a `CourseRegistration` 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	registerForChangedCourseRegistrationsForRegistration
Description	Register for notifications of updated course registrations for the given registration. `CourseRegistrationReceiver.changedCourseRegistrations()` is invoked when a `CourseRegistration` in this course catalog is changed.
Parameters	`osid.id.Id`	`registrationId`	the `Id` of the `Registration` to monitor
Errors	NULL_ARGUMENT		`registrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCourseRegistrationsForCourseOffering
Description	Register for notifications of updated course registrations for the given course offering. `CourseRegistrationReceiver.changedCourseRegistrations()` is invoked when a `CourseRegistration` in this course catalog is changed.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of the `CourseOffering` to monitor
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCourseRegistrationsForStudent
Description	Register for notifications of updated course registrations for the given student. `CourseRegistrationReceiver.changedCourseRegistrations()` is invoked when a `CourseRegistration` in this course catalog is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCourseRegistration
Description	Register for notifications of an updated course registration. `CourseRegistrationReceiver.changedCourseRegistrations()` is invoked when the specified `CourseRegistration` in this course catalog is changed.
Parameters	`osid.id.Id`	`courseRegistrationId`	the `Id` of the `CourseRegistration` to monitor
Errors	NULL_ARGUMENT		`courseRegistrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCourseRegistrations
Description	Registers for notification of deleted course registrations. `CourseRegistrationReceiver.deletedCourseRegistrations()` is invoked when a course registration 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	registerForDeletedCourseRegistrationsForRegistration
Description	Registers for notification of deleted course registrations for thegiven registration. `CourseRegistrationReceiver.deletedCourseRegistrations()` is invoked when a course registration is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`registrationId`	the `Id` of the `Registration` to monitor
Errors	NULL_ARGUMENT		`registrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCourseRegistrationsForCourseOffering
Description	Registers for notification of deleted course registrations for the given course offering. `CourseRegistrationReceiver.deletedCourseRegistrations()` is invoked when a course registration is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of the `CourseOffering` to monitor
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCourseRegistrationsForStudent
Description	Registers for notification of deleted course registrations for the given student. `CourseRegistrationReceiver.deletedCourseRegistrations()` is invoked when a course registration is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the `Resource` to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCourseRegistration
Description	Registers for notification of a deleted course registration. `CourseRegistrationReceiver.deletedCourseRegistrations()` is invoked when the specified course registration is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`courseRegistrationId`	the `Id` of the `CourseRegistration` to monitor
Errors	NULL_ARGUMENT		`courseRegistrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.