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

Interface	osid.course.registration.RegistrationNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Registration` objects in this `CourseCatalog.` This also includes existing 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 views defined in this session correspond to the views in the `RegistrationLookupSession.`
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	canRegisterForRegistrationNotifications
Description	Tests if this user can register for `Registration` 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 registrations 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	reliableRegistrationNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRegistrationNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRegistrationNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRegistrationNotification
Description	Acknowledge a 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	registerForNewRegistrations
Description	Register for notifications of new registrations. `RegistrationReceiver.newRegistrations()` is invoked when a new `Registration` 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	registerForNewRegistrationsForActivityBundle
Description	Register for notifications of new registrations for the given activity bundle. `RegistrationReceiver.newRegistrations()` is invoked when a new `Registration` appears in this course catalog.
Parameters	`osid.id.Id`	`activityBundleId`	the `Id` of the `ActivityBundle` to monitor
Errors	NULL_ARGUMENT		`activityBundleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRegistrationsForCourseOffering
Description	Register for notifications of new registrations for the given course offering. `RegistrationReceiver.newRegistrations()` is invoked when a new `Registration` 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	registerForNewRegistrationsForStudent
Description	Register for notifications of new registrations for the given sudent resource. `RegistrationReceiver.newRegistrations()` is invoked when a new `Registration` appears in this course catalog.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the student 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	registerForChangedRegistrations
Description	Registers for notification of updated registrations. `RegistrationReceiver.changedRegistrations()` is invoked when a course 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	registerForChangedRegistrationsForActivityBundle
Description	Registers for notification of updated registrations for the given activity bundle. `RegistrationReceiver.changedRegistrations()` is invoked when a course in this course catalog is changed.
Parameters	`osid.id.Id`	`activityBundleId`	the `Id` of the `ActivityBundle` to monitor
Errors	NULL_ARGUMENT		`activityBundleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRegistrationsForCourseOffering
Description	Registers for notification of updated registrations for the given course offering. `RegistrationReceiver.changedRegistrations()` is invoked when a course 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	registerForChangedRegistrationsForStudent
Description	Registers for notification of updated registrations for the given student. `RegistrationReceiver.changedRegistrations()` is invoked when a course in this course catalog is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the student 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	registerForChangedRegistration
Description	Registers for notification of an updated registration. `RegistrationReceiver.changedRegistrations()` is invoked when the specified registration 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	registerForDeletedRegistrations
Description	Registers for notification of deleted registrations. `RegistrationReceiver.deletedRegistrations()` is invoked when a 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	registerForDeletedRegistrationsForActivityBundle
Description	Registers for notification of deleted registrations for the given activity bundle. `RegistrationReceiver.deletedRegistrations()` is invoked when a registration is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`activityBundleId`	the `Id` of the `ActivityBundle` to monitor
Errors	NULL_ARGUMENT		`activityBundleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRegistrationsForCourseOffering
Description	Registers for notification of deleted registrations for the given course offering. `RegistrationReceiver.deletedRegistrations()` is invoked when a 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	registerForDeletedRegistrationsForStudent
Description	Registers for notification of deleted registrations for the given student. `RegistrationReceiver.deletedRegistrations()` is invoked when a registration is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the student 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	registerForDeletedRegistration
Description	Registers for notification of a deleted registration. `RegistrationReceiver.deletedRegistrations()` is invoked when the specified 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.