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

Interface	osid.course.registration.request.RegistrationRequestNotificationSession
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` quests in this `CourseCatalog`. This also includes existing registration requests 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 `RegistrationRequestLookupSess` ion.
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	canRegisterForRegistrationRequestNotifications
Description	Tests if this user can register for `RegistrationR` equest 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 requests 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	reliableRegistrationRequestNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeRegistrationRequestNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableRegistrationRequestNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeRegistrationRequestNotification
Description	Acknowledge a registration request 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	registerForNewRegistrationRequests
Description	Register for notifications of new registration requests. `RegistrationRequestReceiver.newRegistrationRequests()` is invoked when a new `RegistrationRequest` 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	registerForNewRegistrationRequestsForRequester
Description	Register for notifications of new registration requests for the given requester. `RegistrationRequestReceiver.newRegistrationRequests()` is invoked when a new `RegistrationRequest` 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	registerForNewRegistrationRequestsForTerm
Description	Register for notifications of new registration requests for the given term. `RegistrationRequestReceiver.newRegistrationRequests()` is invoked when a new `RegistrationRequest` appears in this course catalog.
Parameters	`osid.id.Id`	`termId`	the `Id` of the `Term` to monitor
Errors	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRegistrationRequests
Description	Register for notifications of updated registration requests. `RegistrationRequestReceiver.changedRegistrationRequests()` is invoked when a `RegistrationRequest` 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	registerForChangedRegistrationRequestsForRequester
Description	Register for notifications of updated registration requests for the given requester. `RegistrationRequestReceiver.changedRegistrationRequests()` is invoked when a `RegistrationRequest` 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	registerForChangedRegistrationRequestsForTerm
Description	Register for notifications of updated registration requests for the given term. `RegistrationRequestReceiver.changedRegistrationRequests()` is invoked when a `RegistrationRequest` in this course catalog is changed.
Parameters	`osid.id.Id`	`termId`	the `Id` of the `Term` to monitor
Errors	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedRegistrationRequest
Description	Register for notifications of an updated registration request. `RegistrationRequestReceiver.changedRegistrationRequests()` is invoked when the specified `RegistrationRequest` 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	registerForDeletedRegistrationRequests
Description	Registers for notification of deleted registration requests. `RegistrationRequestReceiver.deletedRegistrationRequests()` is invoked when a registration request 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	registerForDeletedRegistrationRequestsForRequester
Description	Registers for notification of deleted registration requests for the given requester. `RegistrationRequestReceiver.deletedRegistrationRequests()` is invoked when a registration request 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	registerForDeletedRegistrationRequestsForTerm
Description	Registers for notification of deleted registration requests for the given term. `RegistrationRequestReceiver.deletedRegistrationRequests()` is invoked when a registration request is deleted or removed from this course catalog.
Parameters	`osid.id.Id`	`termId`	the `Id` of the `Term` to monitor
Errors	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedRegistrationRequest
Description	Registers for notification of a deleted registration request. `RegistrationRequestReceiver.deletedRegistrationRequests()` is invoked when the specified registration request 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.