OSID - osid.cataloging.CatalogNotificationSession Service Interface Definition

Interface	osid.cataloging.CatalogNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `Catalog` objects. 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 `Catalog` object itself. Adding and removing `Ids` result in notifications available from the notification session for catalog entries.
Method	canRegisterForCatalogNotifications
Description	Tests if this user can register for `Catalog` 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	reliableCatalogNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCatalogNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCatalogNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCatalogNotification
Description	Acknowledge a catalog 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	registerForNewCatalogs
Description	Register for notifications of new catalogs. `CatalogReceiver.newCatalogs()` is invoked when a new `Catalog` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalogs
Description	Registers for notification of updated catalogs. `CatalogReceiver.changedCatalogs()` is invoked when a catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalog
Description	Registers for notification of an updated catalog. `CatalogReceiver.changedCatalogs()` is invoked when the specified catalog is changed.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog` to monitor
Errors	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCatalogs
Description	Registers for notification of deleted catalogs. `CatalogReceiver.deletedCatalogs()` is invoked when a catalog is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCatalog
Description	Registers for notification of a deleted catalog. `CatalogReceiver.deletedCatalogs()` is invoked when the specified catalog is deleted.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog` to monitor
Errors	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalogHierarchy
Description	Registers for notification of an updated catalog hierarchy structure. `CatalogReceiver.changedChildOfCatalogs()` is invoked when a node 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	registerForChangedCatalogHierarchyForAncestors
Description	Catalog `Receiver.changedChildOfCatalogs()` is invoked when the specified node or any of its ancestors experiences a change in its children.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `Catalog` node to monitor
Errors	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalogHierarchyForDescendants
Description	Registers for notification of an updated catalog hierarchy structure. `CatalogReceiver.changedChildOfCatalogs()` is invoked when the specified node or any of its descendants experiences a change in its children.
Parameters	`osid.id.Id`	`catalogId`	the `Id` of the `catalog` node to monitor
Errors	NULL_ARGUMENT		`catalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.