OSID - osid.offering.rules.CanonicalUnitProcessorNotificationSession Service Interface Definition

Interface	osid.offering.rules.CanonicalUnitProcessorNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.offering.rules.OfferingRulesManager`
Used By	`osid.offering.rules.OfferingRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `CanonicalUnitProcessor` objects in this `Catalogue`. This also includes existing `CanonicalUnitProcessors` that may appear or disappear due to changes in the `Catalogue` 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 `CanonicalUnitProcessorLookupSession`.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForCanonicalUnitProcessorNotifications
Description	Tests if this user can register for `CanonicalUnitProcessor` 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	useFederatedCatalogueView
Description	Federates the view for methods in this session. A federated view will include in catalogues which are children of this catalogue in the catalogue hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogueView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableCanonicalUnitProcessorNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCanonicalUnitProcessorNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCanonicalUnitProcessorNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCanonicalUnitProcessorNotification
Description	Acknowledge a canonical unit processor 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	registerForNewCanonicalUnitProcessors
Description	Register for notifications of new canonical unit processors. `CanonicalUnitProcessorReceiver.newCanonicalUnitProcessors()` is invoked when a new `CanonicalUnitProcessor` appears in this catalogue.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCanonicalUnitProcessors
Description	Registers for notification of updated catalogues. `CanonicalUnitProcessorReceiver.changedCanonicalUnitProcessors()` is invoked when a canonical unit processor in this catalogue is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCanonicalUnitProcessor
Description	Registers for notification of an updated canonical unit processor. `ProvisionableReceiver.changedCanonicalUnitProcessors()` is invoked when the specified canonical unit processor in this catalogue is changed.
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of the `CanonicalUnitProcessor` to monitor
Errors	NULL_ARGUMENT		`canonicalUnitProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCanonicalUnitProcessors
Description	Registers for notification of deleted canonical unit processors. `CanonicalUnitProcessorReceiver.deletedCanonicalUnitProcessors()` is invoked when a canonical unit processor is deleted or removed from this catalogue.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCanonicalUnitProcessor
Description	Registers for notification of a deleted canonical unit processor. `CanonicalUnitProcessorReceiver.deletedCanonicalUnitProcessors()` is invoked when the specified canonical unit processor is deleted or removed from this catalogue.
Parameters	`osid.id.Id`	`canonicalUnitProcessorId`	the `Id` of the `CanonicalUnitProcessor` to monitor
Errors	NULL_ARGUMENT		`canonicalUnitProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.