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

Interface	osid.course.registration.ActivityRegistrationNotificationSession
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 `ActivityRegistration` objects in this `CourseCatalog`. This also includes existing activity 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 `ActivityRegistrationLookupSession`.
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	canRegisterForActivityRegistrationNotifications
Description	Tests if this user can register for `ActivityRegistration` 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 activity 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	reliableActivityRegistrationNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeActivityRegistrationNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableActivityRegistrationNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeActivityRegistrationNotification
Description	Acknowledge an activity 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	registerForNewActivityRegistrations
Description	Register for notifications of new activity registrations. `ActivityRegistrationReceiver.newActivityRegistrations()` is invoked when a new `ActivityRegistration` 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	registerForNewActivityRegistrationsForRegistration
Description	Register for notifications of new registrations for the given registration. `ActivityRegistrationReceiver.newActivityRegistrations()` is invoked when a new `ActivityRegistration` 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	registerForNewActivityRegistrationsForActivity
Description	Register for notifications of new registrations for the given activity. `ActivityRegistrationReceiver.newActivityRegistrations()` is invoked when a new `ActivityRegistration` appears in this course catalog.
Parameters	`osid.id.Id`	`activityId`	the `Id` of the `Activity` to monitor
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewActivityRegistrationsForStudent
Description	Register for notifications of new registrations for the given student. `ActivityRegistrationReceiver.newActivityRegistrations()` is invoked when a new `ActivityRegistration` 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	registerForChangedActivityRegistrations
Description	Registers for notification of updated activity registrations. `ActivityRegistrationReceiver.changedActivityRegistrations()` 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	registerForChangedActivityRegistrationsForRegistration
Description	Registers for notification of updated activity registrations for the given registration. `ActivityRegistrationReceiver.changedActivityRegistrations()` is invoked when a course 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	registerForChangedActivityRegistrationsForActivity
Description	Registers for notification of updated activity registrations for the given activity. `ActivityRegistrationReceiver.changedActivityRegistrations()` is invoked when a course in this course catalog is changed.
Parameters	`osid.id.Id`	`activityId`	the `Id` of the `Activity` to monitor
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedActivityRegistrationsForStudent
Description	Registers for notification of updated activity registrations for the given student. `ActivityRegistrationReceiver.changedActivityRegistrations()` is invoked when a course 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	registerForChangedActivityRegistration
Description	Registers for notification of an updated activity registration. `ActivityRegistrationReceiver.changedActivityRegistrations()` is invoked when the specified activity registration in this course catalog is changed.
Parameters	`osid.id.Id`	`activityRegistrationId`	the `Id` of the `ActivityRegistration` to monitor
Errors	NULL_ARGUMENT		`activityRegistrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivityRegistrations
Description	Registers for notification of deleted activity registrations. `ActivityRegistrationReceiver.deletedActivityRegistrations()` is invoked when an activity 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	registerForDeletedActivityRegistrationsForRegistration
Description	Registers for notification of deleted activity registrations for the given registration. `ActivityRegistrationReceiver.deletedActivityRegistrations()` is invoked when an activity 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	registerForDeletedActivityRegistrationsForActivity
Description	Registers for notification of deleted activity registrations for the given activity. `ActivityRegistrationReceiver.deletedActivityRegistrations()` is invoked when an activity registration is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`activityId`	the `Id` of the `Activity` to monitor
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedActivityRegistrationsForStudent
Description	Registers for notification of deleted activity registrations for the given student. `ActivityRegistrationReceiver.deletedActivityRegistrations()` is invoked when an activity 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	registerForDeletedActivityRegistration
Description	Registers for notification of a deleted activity registration. `ActivityRegistrationReceiver.deletedActivityRegistrations()` is invoked when the specified activity registration is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`activityRegistrationId`	the `Id` of the `ActivityRegistration` to monitor
Errors	NULL_ARGUMENT		`activityRegistrationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.