Interface | osid.ordering.OrderNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
Method | getStoreId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Store Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getStore | ||
Description |
Gets the | ||
Return | osid.ordering.Store | the store | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForOrderNotifications | ||
Description |
Tests if this user can register for | ||
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 | registerForNewOrders | ||
Description |
Register for notifications of new orders. | ||
Errors | OPERATION_FAILED | unable to complete request | |
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 | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedOrdersByCustomer | ||
Description |
Register for notifications of changed orders for the
given customer | ||
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. | ||
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. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedOrdersByCustomer | ||
Description |
Register for notifications of deleted orders for the
given customer | ||
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. | ||
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. |