OSID Logo
OSID Specifications
ordering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ordering.OrderNotificationSession
Implementsosid.OsidSession
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.

MethodgetStoreId
Description

Gets the Store Id associated with this session.

Returnosid.id.Idthe Store Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetStore
Description

Gets the Store associated with this session.

Returnosid.ordering.Storethe store
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForOrderNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedStoreView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedStoreView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this store only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewOrders
Description

Register for notifications of new orders. OrderReceiver.newOrders() is invoked when a new Order is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewOrdersByCustomer
Description

Register for notifications of new orders for the given customer resource Id. OrderReceiver.newOrders() is invoked when a new Order is created.

Parametersosid.id.IdresourceIdthe Id of the customer to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOrders
Description

Registers for notification of updated orders. OrderReceiver.changedOrders() is invoked when an order is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOrdersByCustomer
Description

Register for notifications of changed orders for the given customer Id. OrderReceiver.changedOrders() is invoked when an Order for the resource is changed.

Parametersosid.id.IdresourceIdthe Id of the customer to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOrder
Description

Registers for notification of an updated order. OrderReceiver.changedOrders() is invoked when the specified order is changed.

Parametersosid.id.IdorderIdthe Id of the Order to monitor
ErrorsNULL_ARGUMENT orderId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOrders
Description

Registers for notification of deleted orders. OrderReceiver.deletedOrders() is invoked when an order is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOrdersByCustomer
Description

Register for notifications of deleted orders for the given customer Id. OrderReceiver.deletedOrders() is invoked when an Order for the resource is deleted.

Parametersosid.id.IdresourceIdthe Id of the customer to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOrder
Description

Registers for notification of a deleted order. OrderReceiver.deletedOrders() is invoked when the specified order is deleted.

Parametersosid.id.IdorderIdthe Id of the Order to monitor
ErrorsNULL_ARGUMENT orderId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.