OSID - osid.ordering.OrderItemNotificationSession Service Interface Definition

Interface	osid.ordering.OrderItemNotificationSession
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 `OrderItem` 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 `OrderItem` object itself. Adding and removing orders result in notifications available from the notification session for orders. Like all `OsidSessions`, `OrderItemNotificationSessions` are dedicated to single processing threads and a single authenticated user.
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	canRegisterForOrderItemNotifications
Description	Tests if this user can register for `OrderItem` 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 order items in stores which are children of this store in the store hierarchy.
Compliance	`mandatory`		This method 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 must be implemented.
Method	reliableOrderItemNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeOrderItemNotification()`.
Compliance	`mandatory`		This method must be implemented.
Method	unreliableOrderItemNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method must be implemented.
Method	acknowledgeOrderItemNotification
Description	Acknowledge an order item 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	registerForNewOrderItems
Description	Register for notifications of new order items. `OrderItemReceiver.newOrderItems()` is invoked when a new `OrderItem` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOrderItems
Description	Registers for notification of updated order items. `OrderItemReceiver.changedOrderItems()` is invoked when an order item is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOrderItem
Description	Registers for notification of an updated order item. `OrderItemReceiver.changedOrderItems()` is invoked when the specified order item is changed.
Parameters	`osid.id.Id`	`orderItemId`	the `Id` of the `OrderItem` to monitor
Errors	NULL_ARGUMENT		`orderItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOrderItems
Description	Registers for notification of deleted order items. `OrderItemReceiver.deletedOrderItems()` is invoked when an order item is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOrderItem
Description	Registers for notification of a deleted order item. `OrderItemReceiver.deletedOrderItems()` is invoked when the specified order item is deleted.
Parameters	`osid.id.Id`	`orderItemId`	the `Id` of the `OrderItem` to monitor
Errors	NULL_ARGUMENT		`orderItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.