OSID - osid.ordering.rules.PriceEnablerNotificationSession Service Interface Definition

Interface	osid.ordering.rules.PriceEnablerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.ordering.rules.OrderingRulesManager`
Used By	`osid.ordering.rules.OrderingRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `PriceEnabler` objects in this `Store`. This also includes existing `PriceEnablers` that may appear or disappear due to changes in the `Store` 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 `PriceEnablerLookupSession`.
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	canRegisterForPriceEnablerNotifications
Description	Tests if this user can register for `PriceEnabler` 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 enablers 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 notifications to this store only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliablePriceEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgePriceEnablerNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliablePriceEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgePriceEnablerNotification
Description	Acknowledge a price enabelr 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	registerForNewPriceEnablers
Description	Register for notifications of new price enablers. `PriceEnablerReceiver.newPriceEnablers()` is invoked when a new `PriceEnabler` appears in this store.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPriceEnablers
Description	Registers for notification of updated store enabelrs. `PriceEnablerReceiver.changedPriceEnablers()` is invoked when a price enabler in this store is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedPriceEnabler
Description	Registers for notification of an updated price enabler. `ProvisionableReceiver.changedPriceEnablers()` is invoked when the specified price enabler in this store is changed.
Parameters	`osid.id.Id`	`priceEnablerId`	the `Id` of the `PriceEnabler` to monitor
Errors	NULL_ARGUMENT		`priceEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPriceEnablers
Description	Registers for notification of deleted price enablers. `PriceEnablerReceiver.deletedPriceEnablers()` is invoked when a price enabler is deleted or removed from this store.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedPriceEnabler
Description	Registers for notification of a deleted price enabler. `PriceEnablerReceiver.deletedPriceEnablers()` is invoked when the specified price enabler is deleted or removed from this store.
Parameters	`osid.id.Id`	`priceEnablerId`	the `Id` of the `PriceEnabler` to monitor
Errors	NULL_ARGUMENT		`priceEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.