OSID - osid.ordering.OrderNotificationSession Service Interface Definition

Interface	osid.ordering.OrderNotificationSession
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 `Order` 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.
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	canRegisterForOrderNotifications
Description	Tests if this user can register for `Order` 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 orders 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	reliableOrderNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeOrderNotification()`.
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableOrderNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeOrderNotification
Description	Acknowledge an order 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	registerForNewOrders
Description	Register for notifications of new orders. `OrderReceiver.newOrders()` is invoked when a new `Order` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewOrdersByCustomer
Description	Register for notifications of new orders for the given customer resource `Id`. `OrderReceiver.newOrders()` is invoked when a new `Order` is created.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the customer to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOrders
Description	Registers for notification of updated orders. `OrderReceiver.changedOrders()` is invoked when an order is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOrdersByCustomer
Description	Register for notifications of changed orders for the given customer `Id`. `OrderReceiver.changedOrders()` is invoked when an `Order` for the resource is changed.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the customer to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedOrder
Description	Registers for notification of an updated order. `OrderReceiver.changedOrders()` is invoked when the specified order is changed.
Parameters	`osid.id.Id`	`orderId`	the `Id` of the `Order` to monitor
Errors	NULL_ARGUMENT		`orderId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOrders
Description	Registers for notification of deleted orders. `OrderReceiver.deletedOrders()` is invoked when an order is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOrdersByCustomer
Description	Register for notifications of deleted orders for the given customer `Id`. `OrderReceiver.deletedOrders()` is invoked when an `Order` for the resource is deleted.
Parameters	`osid.id.Id`	`resourceId`	the `Id` of the customer to monitor
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedOrder
Description	Registers for notification of a deleted order. `OrderReceiver.deletedOrders()` is invoked when the specified order is deleted.
Parameters	`osid.id.Id`	`orderId`	the `Id` of the `Order` to monitor
Errors	NULL_ARGUMENT		`orderId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.