OSID Logo
OSID Specifications
inventory shipment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inventory.shipment.ShipmentNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Shipment objects in this Warehouse. This also includes existing shipments that may appear or disappear due to changes in the Warehouse hierarchy, 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.

The two views defined in this session correspond to the views in the ShipmentLookupSession.

MethodgetWarehouseId
Description

Gets the Warehouse Id associated with this session.

Returnosid.id.Idthe Warehouse Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetWarehouse
Description

Gets the Warehouse associated with this session.

Returnosid.inventory.Warehousethe warehouse
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForShipmentNotifications
Description

Tests if this user can register for Shipment 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.
MethoduseFederatedWarehouseView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedWarehouseView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this warehouse only.

CompliancemandatoryThis method is must be implemented.
MethodreliableShipmentNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeShipmentNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableShipmentNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeShipmentNotification
Description

Acknowledge a shipment notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewShipments
Description

Register for notifications of new shipments. ShipmentReceiver.newShipments() is invoked when a new Shipment appears in this warehouse.

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

Register for notifications of new shipments for the given source. ShipmentReceiver.newShipments() is invoked when a new Shipment appears in this warehouse.

Parametersosid.id.IdsourceIdthe Id of the source to monitor
ErrorsNULL_ARGUMENT sourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewShipmentsForStock
Description

Register for notifications of new shipments for the given stock. ShipmentReceiver.newShipments() is invoked when a new Shipment appears in this warehouse.

Parametersosid.id.IdstockIdthe Id of the Stock to monitor
ErrorsNULL_ARGUMENT stockId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedShipments
Description

Registers for notification of updated shipments. ShipmentReceiver.changedShipments() is invoked when a shipment in this warehouse is changed.

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

Registers for notification of updated shipments for the given source. ShipmentReceiver.changedShipments() is invoked when the specified shipment in this warehouse is changed.

Parametersosid.id.IdsourceIdthe Id of the source to monitor
ErrorsNULL_ARGUMENT sourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedShipmentsForStock
Description

Registers for notification of updated shipments for the given stock. ShipmentReceiver.changedShipments() is invoked when the specified shipment in this warehouse is changed.

Parametersosid.id.IdstockIdthe Id of the Stock to monitor
ErrorsNULL_ARGUMENT stockId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedShipment
Description

Registers for notification of an updated shipment. ShipmentReceiver.changedShipments() is invoked when the specified shipment in this warehouse is changed.

Parametersosid.id.IdshipmentIdthe Id of the Shipment to monitor
ErrorsNULL_ARGUMENT shipmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedShipments
Description

Registers for notification of deleted shipments. ShipmentReceiver.deletedShipments() is invoked when a shipment is deleted or removed from this warehouse.

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

Registers for notification of deleted shipments for the given source. ShipmentReceiver.deletedShipments() is invoked when the specified shipment is deleted or removed from this warehouse.

Parametersosid.id.IdsourceIdthe Id of the source to monitor
ErrorsNULL_ARGUMENT sourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedShipmentsForStock
Description

Registers for notification of deleted shipments for the given stock. ShipmentReceiver.deletedShipments() is invoked when the specified shipment is deleted or removed from this warehouse.

Parametersosid.id.IdstockIdthe Id of the Stock to monitor
ErrorsNULL_ARGUMENT stockId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedShipment
Description

Registers for notification of a deleted shipment. ShipmentReceiver.deletedShipments() is invoked when the specified shipment is deleted or removed from this warehouse.

Parametersosid.id.IdshipmentIdthe Id of the Shipment to monitor
ErrorsNULL_ARGUMENT shipmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.