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

Interface	osid.course.registration.RegistrationTargetNotificationSession
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 `RegistrationTa` rgets in this `CourseCatalog` . This also includes existing registration targets 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 `RegistrationTargetLookupSessi` 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	canRegisterForRegistrationTargetNotifications
Description	Tests if this user can register for `RegistrationT` arget 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 registration targets 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	reliableRegistrationTargetNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRegistrationTargetNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRegistrationTargetNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRegistrationTargetNotification
Description	Acknowledge a registration target 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	registerForNewRegistrationTargets
Description	Register for notifications of new registration targets. `RegistrationTargetReceiver.newRegistrationTargets()` is invoked when a new `RegistrationTarget` 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	registerForNewRegistrationTargetsForCourseOffering
Description	Register for notifications of new registration targets for the given course offering. `RegistrationTargetReceiver.newRegistrationTargets()` is invoked when a new `RegistrationTarget` appears in this course catalog.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of a `CourseOffering`
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewRegistrationTargetsForActivity
Description	Register for notifications of new registration targets for the given activity. `RegistrationTargetReceiver.newRegistrationTargets()` is invoked when a new `RegistrationTarget` appears in this course catalog.
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRegistrationTargets
Description	Register for notifications of updated registration targets. `RegistrationTargetReceiver.changedRegistrationTargets()` is invoked when a `RegistrationTarget` 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	registerForChangedRegistrationTargetsForCourseOffering
Description	Register for notifications of updated registration targets for the given course offering. `RegistrationTargetReceiver.changedRegistrationTargets()` is invoked when a `RegistrationTarget` in this course catalog is changed.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of a `CourseOffering`
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRegistrationTargetsForActivity
Description	Register for notifications of updated registration targets for the given activity. `RegistrationTargetReceiver.changedRegistrationTargets()` is invoked when a `RegistrationTarget` in this course catalog is changed.
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRegistrationTarget
Description	Register for notifications of an updated registration target. `RegistrationTargetReceiver.changedRegistrationTargets()` is invoked when the specified `RegistrationTarget` in this course catalog is changed.
Parameters	`osid.id.Id`	`registrationTargetId`	the `Id` of the `RegistrationTarget` to monitor
Errors	NULL_ARGUMENT		`registrationTargetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRegistrationTargets
Description	Registers for notification of deleted registration targets. `RegistrationTargetReceiver.deletedRegistrationTargets()` is invoked when a registration target 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	registerForDeletedRegistrationTargetsForCourseOffering
Description	Registers for notification of deleted registration targets for the given course offering. `RegistrationTargetReceiver.deletedRegistrationTargets()` is invoked when a registration target is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`courseOfferingId`	the `Id` of a `CourseOffering`
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRegistrationTargetsForActivity
Description	Registers for notification of deleted registration targets for the given activity. `RegistrationTargetReceiver.deletedRegistrationTargets()` is invoked when a registration target is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`activityId`	the `Id` of an activity
Errors	NULL_ARGUMENT		`activityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRegistrationTarget
Description	Registers for notification of a deleted registration target. `RegistrationTargetReceiver.deletedRegistrationTargets()` is invoked when the specified registration target is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`registrationTargetId`	the `Id` of the `RegistrationTarget` to monitor
Errors	NULL_ARGUMENT		`registrationTargetId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.