OSID - osid.offering.CatalogueNotificationSession Service Interface Definition

Interface	osid.offering.CatalogueNotificationSession
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 `Catalogues`. 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. Notifications are triggered with changes to the `Catalogue` object itself. Adding and removing canonical units result in notifications available from the notification session for canonical units.
Method	canRegisterForCatalogueNotifications
Description	Tests if this user can register for `Catalogue` 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	reliableCatalogueNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCatalogueNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCatalogueNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCatalogueNotification
Description	Acknowledge a catalogue 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	registerForNewCatalogues
Description	Register for notifications of new catalogues. `CatalogueReceiver.newCatalogues()` is invoked when a new `Catalogue` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalogues
Description	Registers for notification of updated catalogues. `CatalogueReceiver.changedCatalogues()` is invoked when a catalogue is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalogue
Description	Registers for notification of an updated catalogue. `CatalogueReceiver.changedCatalogues()` is invoked when the specified catalogue is changed.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue` to monitor
Errors	NULL_ARGUMENT		`catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCatalogues
Description	Registers for notification of deleted catalogues. `CatalogueReceiver.deletedCatalogues()` is invoked when a catalogue is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCatalogue
Description	Registers for notification of a deleted catalogue. `CatalogueReceiver.deletedCatalogues()` is invoked when the specified catalogue is deleted.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue` to monitor
Errors	NULL_ARGUMENT		`catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalogueHierarchy
Description	Registers for notification of an updated catalogue hierarchy structure. `CatalogueReceiver.changedChildOfCatalogues()` is invoked when the specified node or any of its descendants experiences a change in its children.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalogueHierarchyForAncestors
Description	Registers for notification of an updated catalogue hierarchy structure. `CatalogueReceiver.changedChildOfCatalogues()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue` node to monitor
Errors	NULL_ARGUMENT		`catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalogueHierarchyForDescendants
Description	Registers for notification of an updated catalogue hierarchy structure. `CatalogueReceiver.changedChildOfCatalogues()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`catalogueId`	the `Id` of the `Catalogue` node to monitor
Errors	NULL_ARGUMENT		`catalogueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.