OSID - osid.course.registration.request.RegistrationRequestItemNotificationSession Service Interface Definition

Interface	osid.course.registration.request.RegistrationRequestItemNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.course.registration.request.RegistrationRequestManager`
Used By	`osid.course.registration.request.RegistrationRequestProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `RegistrationRe` questItems in this `CourseCatalog` . This also includes existing registration request items 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 `RegistrationRequestItemLookup` Session.
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.CourseCatalogList`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForRegistrationRequestItemNotifications
Description	Tests if this user can register for `RegistrationR` equestItem 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 request items 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	reliableRegistrationRequestItemNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRegistrationRequestItemNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRegistrationRequestItemNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRegistrationRequestItemNotification
Description	Acknowledge a registration request item 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	registerForNewRegistrationRequestItems
Description	Register for notifications of new registration request items. `RegistrationRequestItemReceiver.newRegistrationRequestItems()` is invoked when a new `RegistrationRequestItem` 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	registerForNewRegistrationRequestItemsForRegistrationRequest
Description	Register for notifications of new registration request items for the given registration request. `RegistrationRequestItemReceiver.newRegistrationRequestItems()` is invoked when a new `RegistrationRequestItem` appears in this course catalog.
Parameters	`osid.id.Id`	`registrationRequestId`	the `Id` of the `RegistrationRequest` to monitor
Errors	NULL_ARGUMENT		`registrationRequestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRegistrationRequestItems
Description	Register for notifications of updated registration request items. `RegistrationRequestItemReceiver.changedRegistrationRequestItems()` is invoked when a `RegistrationRequestItem` 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	registerForChangedRegistrationRequestItemsForRegistrationRequest
Description	Register for notifications of updated registration request items for thegiven registration request. `RegistrationRequestItemReceiver.changedRegistrationRequestItems()` is invoked when a `RegistrationRequestItem` in this course catalog is changed.
Parameters	`osid.id.Id`	`registrationRequestId`	the `Id` of the `RegistrationRequest` to monitor
Errors	NULL_ARGUMENT		`registrationRequestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRegistrationRequestItem
Description	Register for notifications of an updated registration request item. `RegistrationRequestItemReceiver.changedRegistrationRequestItems()` is invoked when the specified `RegistrationRequestItem` in this course catalog is changed.
Parameters	`osid.id.Id`	`registrationRequestItemId`	the `Id` of the `RegistrationRequestItem` to monitor
Errors	NULL_ARGUMENT		`registrationRequestItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRegistrationRequestItems
Description	Registers for notification of deleted registration request items. `RegistrationRequestItemReceiver.deletedRegistrationRequestItems()` is invoked when a registration request item 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	registerForDeletedRegistrationRequestItemsForRegistrationRequest
Description	Registers for notification of deleted registration request items for the given registration request. `RegistrationRequestItemReceiver.deletedRegistrationRequestItems()` is invoked when a registration request item is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`registrationRequestId`	the `Id` of the `RegistrationRequest` to monitor
Errors	NULL_ARGUMENT		`registrationRequestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRegistrationRequestItem
Description	Registers for notification of a deleted registration request item. `RegistrationRequestItemReceiver.deletedRegistrationRequestItems()` is invoked when the specified registration request item is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`registrationRequestItemId`	the `Id` of the `RegistrationRequestItem` to monitor
Errors	NULL_ARGUMENT		`registrationRequestItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.