OSID - osid.ordering.ProductNotificationSession Service Interface Definition

Interface	osid.ordering.ProductNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.ordering.OrderingManager`
Used By	`osid.ordering.OrderingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Product` 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 `Product` object itself. Adding and removing orders result in notifications available from the notification session for orders.
Method	getStoreId
Description	Gets the `Store` `Id` associated with this session.
Return	`osid.id.Id`		the `Store Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getStore
Description	Gets the `Store` associated with this session.
Return	`osid.ordering.Store`		the store
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForProductNotifications
Description	Tests if this user can register for `Product` 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	useFederatedStoreView
Description	Federates the view for methods in this session. A federated view will include products in stores which are children of this store in the store hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedStoreView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this store only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableProductNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeProductNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableProductNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeProductNotification
Description	Acknowledge a product 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	registerForNewProducts
Description	Register for notifications of new products. `ProductReceiver.newProducts()` is invoked when a new `Product` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProducts
Description	Registers for notification of updated products. `ProductReceiver.changedProducts()` is invoked when a product is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedProduct
Description	Registers for notification of an updated product. `ProductReceiver.changedProducts()` is invoked when the specified product is changed.
Parameters	`osid.id.Id`	`productId`	the `Id` of the `Product` to monitor
Errors	NULL_ARGUMENT		`productId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProducts
Description	Registers for notification of deleted products. `ProductReceiver.deletedProducts()` is invoked when a product is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedProduct
Description	Registers for notification of a deleted product. `ProductReceiver.deletedProducts()` is invoked when the specified product is deleted.
Parameters	`osid.id.Id`	`productId`	the `Id` of the `Product` to monitor
Errors	NULL_ARGUMENT		`productId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.