OSID - osid.cataloging.rules.CatalogEnablerNotificationSession Service Interface Definition

Interface	osid.cataloging.rules.CatalogEnablerNotificationSession
Implements	`osid.OsidSession`
Description	This session defines methods to receive notifications on adds/changes to `CatalogEnabler` objects in this `Catalog.` This also includes existing `CatalogEnablers` that may appear or disappear due to changes in the `Catalog` 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 `CatalogEnablerLookupSession.`
Method	getCatalogId
Description	Gets the `Catalog` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalog
Description	Gets the `Catalog` associated with this session.
Return	`osid.cataloging.Catalog`		the catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForCatalogEnablerNotifications
Description	Tests if this user can register for `CatalogEnabler` 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	useFederatedCatalogView
Description	Federates the view for methods in this session. A federated view will include enablers in catalogs which are children of this catalog in the catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableCatalogEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeCatalogEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableCatalogEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeCatalogEnablerNotification
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	registerForNewCatalogEnablers
Description	Register for notifications of new catalog enablers. `CatalogEnablerReceiver.newCatalogEnabler()` is invoked when a new `CatalogEnabler` appears in this catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalogEnablers
Description	Registers for notification of updated catalog enablers. `CatalogEnablerReceiver.changedCatalogEnabler()` is invoked when a catalog enabler in this catalog is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedCatalogEnabler
Description	Registers for notification of an updated catalog enabler. `ProvisionableReceiver.changedCatalogEnabler()` is invoked when the specified catalog enabler in this catalog is changed.
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of the `CatalogEnabler` to monitor
Errors	NULL_ARGUMENT		`catalogEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCatalogEnablers
Description	Registers for notification of deleted catalog enablers. `CatalogEnablerReceiver.deletedCatalogEnabler()` is invoked when a catalog enabler is deleted or removed from this catalog.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedCatalogEnabler
Description	Registers for notification of a deleted catalog enabler. `CatalogEnablerReceiver.deletedCatalogEnabler()` is invoked when the specified catalog enabler is deleted or removed from this catalog.
Parameters	`osid.id.Id`	`catalogEnablerId`	the `Id` of the `CatalogEnabler` to monitor
Errors	NULL_ARGUMENT		`catalogEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.