public interface ShipmentNotificationSession extends OsidSession
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.
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeShipmentNotification(Id notificationId)
Acknowledge a shipment notification.
|
boolean |
canRegisterForShipmentNotifications()
Tests if this user can register for
Shipment
notifications. |
Warehouse |
getWarehouse()
Gets the
Warehouse associated with this session. |
Id |
getWarehouseId()
Gets the
Warehouse Id associated with
this session. |
void |
registerForChangedShipment(Id shipmentId)
Registers for notification of an updated shipment.
|
void |
registerForChangedShipments()
Registers for notification of updated shipments.
|
void |
registerForChangedShipmentsForSource(Id sourceId)
Registers for notification of updated shipments for the given source.
|
void |
registerForChangedShipmentsForStock(Id stockId)
Registers for notification of updated shipments for the given stock.
|
void |
registerForDeletedShipment(Id shipmentId)
Registers for notification of a deleted shipment.
|
void |
registerForDeletedShipments()
Registers for notification of deleted shipments.
|
void |
registerForDeletedShipmentsForSource(Id sourceId)
Registers for notification of deleted shipments for the given source.
|
void |
registerForDeletedShipmentsForStock(Id stockId)
Registers for notification of deleted shipments for the given stock.
|
void |
registerForNewShipments()
Register for notifications of new shipments.
|
void |
registerForNewShipmentsForSource(Id sourceId)
Register for notifications of new shipments for the given source.
|
void |
registerForNewShipmentsForStock(Id stockId)
Register for notifications of new shipments for the given stock.
|
void |
reliableShipmentNotifications()
Reliable notifications are desired.
|
void |
unreliableShipmentNotifications()
Unreliable notifications are desired.
|
void |
useFederatedWarehouseView()
Federates the view for methods in this session.
|
void |
useIsolatedWarehouseView()
Isolates the view for methods in this session.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getWarehouseId()
Warehouse
Id
associated with
this session. Warehouse Id
associated with this sessionmandatory
- This method must be implemented. Warehouse getWarehouse() throws OperationFailedException, PermissionDeniedException
Warehouse
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canRegisterForShipmentNotifications()
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. false
if notification methods are not
authorized, true
otherwisemandatory
- This method must be implemented. void useFederatedWarehouseView()
mandatory
- This method is must be implemented. void useIsolatedWarehouseView()
mandatory
- This method is must be implemented. void reliableShipmentNotifications()
acknowledgeShipmentNotification()
.mandatory
- This method is must be implemented. void unreliableShipmentNotifications()
mandatory
- This method is must be implemented. void acknowledgeShipmentNotification(Id notificationId) throws OperationFailedException, PermissionDeniedException
notificationId
- the Id
of the notificationOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewShipments() throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.newShipments()
is invoked when a new
Shipment
appears in this warehouse.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewShipmentsForSource(Id sourceId) throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.newShipments()
is invoked when a new
Shipment
appears in this warehouse.sourceId
- the Id
of the source to monitorNullArgumentException
- sourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForNewShipmentsForStock(Id stockId) throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.newShipments()
is invoked when a new
Shipment
appears in this warehouse.stockId
- the Id
of the Stock
to
monitorNullArgumentException
- stockId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedShipments() throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.changedShipments()
is invoked when a shipment
in this warehouse is changed.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedShipmentsForSource(Id sourceId) throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.changedShipments()
is invoked when the
specified shipment in this warehouse is changed.sourceId
- the Id
of the source to monitorNullArgumentException
- sourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedShipmentsForStock(Id stockId) throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.changedShipments()
is invoked when the
specified shipment in this warehouse is changed.stockId
- the Id
of the Stock
to
monitorNullArgumentException
- stockId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForChangedShipment(Id shipmentId) throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.changedShipments()
is invoked when the
specified shipment in this warehouse is changed.shipmentId
- the Id
of the Shipment
to monitorNullArgumentException
- shipmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedShipments() throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.deletedShipments()
is invoked when a shipment
is deleted or removed from this warehouse.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedShipmentsForSource(Id sourceId) throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.deletedShipments()
is invoked when the
specified shipment is deleted or removed from this warehouse.sourceId
- the Id
of the source to monitorNullArgumentException
- sourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedShipmentsForStock(Id stockId) throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.deletedShipments()
is invoked when the
specified shipment is deleted or removed from this warehouse.stockId
- the Id
of the Stock
to
monitorNullArgumentException
- stockId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void registerForDeletedShipment(Id shipmentId) throws OperationFailedException, PermissionDeniedException
ShipmentReceiver.deletedShipments()
is invoked when the
specified shipment is deleted or removed from this warehouse.shipmentId
- the Id
of the Shipment
to monitorNullArgumentException
- shipmentId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.