OSID - osid.ordering.StoreNotificationSession Service Interface Definition

Interface	osid.ordering.StoreNotificationSession
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 `Store` 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 `Store` object itself. Adding and removing orders result in notifications available from the notification session for orders.
Method	canRegisterForStoreNotifications
Description	Tests if this user can register for `Store` 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	reliableStoreNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeStoreNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableStoreNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeStoreNotification
Description	Acknowledge a store 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	registerForNewStores
Description	Register for notifications of new stores. `StoreReceiver.newStores()` is invoked when a new `Store` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedStores
Description	Registers for notification of updated stores. `StoreReceiver.changedStores()` is invoked when a store is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedStore
Description	Registers for notification of an updated store. `StoreReceiver.changedStores()` is invoked when the specified store is changed.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store` to monitor
Errors	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedStores
Description	Registers for notification of deleted stores. `StoreReceiver.deletedStores()` is invoked when a store is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedStore
Description	Registers for notification of a deleted store. `StoreReceiver.deletedStores()` is invoked when the specified store is deleted.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store` to monitor
Errors	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedStoreHierarchy
Description	Registers for notification of an updated store hierarchy structure. `StoreReceiver.changedChildOfStores()` 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	registerForChangedStoreHierarchyForAncestors
Description	Registers for notification of an updated store hierarchy structure. `StoreReceiver.changedChildOfStores()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store` node to monitor
Errors	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedStoreHierarchyForDescendants
Description	Registers for notification of an updated store hierarchy structure. `StoreReceiver.changedChildOfStores()` is invoked when a node experiences a change in its children.
Parameters	`osid.id.Id`	`storeId`	the `Id` of the `Store` node to monitor
Errors	NULL_ARGUMENT		`storeId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.