OSID - osid.offering.CanonicalUnitNotificationSession Service Interface Definition

Interface	osid.offering.CanonicalUnitNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `CanonicalUnits`. 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.
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	canRegisterForCanonicalUnitNotifications
Description	Tests if this user can register for `CanonicalUnit` 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 notifications for canonical unitss 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	reliableCanonicalUnitNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCanonicalUnitNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCanonicalUnitNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCanonicalUnitNotification
Description	Acknowledge a canonial unit 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	registerForNewCanonicalUnits
Description	Register for notifications of new canonical units. `CanonicalUnitReceiver.newCanonicalUnits()` is invoked when a new `CanonicalUnit` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCanonicalUnits
Description	Registers for notification of updated canonical units. `CanonicalUnitReceiver.changedCanonicalUnits()` is invoked when a canonical unit 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	registerForChangedCanonicalUnit
Description	Registers for notification of an updated canonical unit. `CanonicalUnitReceiver.changedCanonicalUnits()` is invoked when the specified canonical unit in this catalogue is changed.
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit` to monitor
Errors	NOT_FOUND		a canonical unit was not found identified by the given `Id`
	NULL_ARGUMENT		`canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCanonicalUnits
Description	Registers for notification of deleted canonical units. `CanonicalUnitReceiver.deletedCanonicalUnits()` is invoked when a canonical unit is removed from this catalogue.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCanonicalUnit
Description	Registers for notification of a deleted canonical unit. `CanonicalUnitReceiver.deletedCanonicalUnits()` is invoked when the specified canonical unit is removed from this catalogue.
Parameters	`osid.id.Id`	`canonicalUnitId`	the `Id` of the `CanonicalUnit` to monitor
Errors	NOT_FOUND		a canonical unit was not found identified by the given `Id`
	NULL_ARGUMENT		`canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.