Interface | osid.inventory.shipment.ShipmentNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getWarehouseId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Warehouse Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getWarehouse | ||
Description |
Gets the | ||
Return | osid.inventory.Warehouse | the warehouse | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForShipmentNotifications | ||
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 | useFederatedWarehouseView | ||
Description |
Federates the view for methods in this session. A federated view will include shipments in catalogs which are children of this catalog in the warehouse hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedWarehouseView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this warehouse only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableShipmentNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableShipmentNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeShipmentNotification | ||
Description |
Acknowledge a shipment notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewShipments | ||
Description |
Register for notifications of new shipments. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewShipmentsForSource | ||
Description |
Register for notifications of new shipments for the
given source. | ||
Parameters | osid.id.Id | sourceId | the Id of the source to monitor |
Errors | NULL_ARGUMENT | sourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewShipmentsForStock | ||
Description |
Register for notifications of new shipments for the
given stock. | ||
Parameters | osid.id.Id | stockId | the Id of the Stock to monitor |
Errors | NULL_ARGUMENT | stockId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedShipments | ||
Description |
Registers for notification of updated shipments. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedShipmentsForSource | ||
Description |
Registers for notification of updated shipments for the
given source. | ||
Parameters | osid.id.Id | sourceId | the Id of the source to monitor |
Errors | NULL_ARGUMENT | sourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedShipmentsForStock | ||
Description |
Registers for notification of updated shipments for the
given stock. | ||
Parameters | osid.id.Id | stockId | the Id of the Stock to monitor |
Errors | NULL_ARGUMENT | stockId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedShipment | ||
Description |
Registers for notification of an updated shipment.
| ||
Parameters | osid.id.Id | shipmentId | the Id of the Shipment to monitor |
Errors | NULL_ARGUMENT | shipmentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedShipments | ||
Description |
Registers for notification of deleted shipments. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedShipmentsForSource | ||
Description |
Registers for notification of deleted shipments for the
given source. | ||
Parameters | osid.id.Id | sourceId | the Id of the source to monitor |
Errors | NULL_ARGUMENT | sourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedShipmentsForStock | ||
Description |
Registers for notification of deleted shipments for the
given stock. | ||
Parameters | osid.id.Id | stockId | the Id of the Stock to monitor |
Errors | NULL_ARGUMENT | stockId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedShipment | ||
Description |
Registers for notification of a deleted shipment.
| ||
Parameters | osid.id.Id | shipmentId | the Id of the Shipment to monitor |
Errors | NULL_ARGUMENT | shipmentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |