Interface ShipmentReceiver

All Superinterfaces:
OsidReceiver
public interface ShipmentReceiver extends OsidReceiver

The shipment receiver is the consumer supplied interface for receiving notifications pertaining to new, updated or deleted Shipment objects.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    changedShipments(Id notificationId, IdList shipmentIds)
    The callback for notification of updated shipments.
    void
    deletedShipments(Id notificationId, IdList shipmentIds)
    the callback for notification of deleted shipments.
    void
    newShipments(Id notificationId, IdList shipmentIds)
    The callback for notifications of new shipments.

    Methods inherited from interface OsidReceiver

    down, up
    Modifier and Type
    Method
    Description
    void
    down()
    The callback for notifications that the notification bus is not operating.
    void
    up()
    The callback for notifications that the notification bus is operational.

  • Method Details

    • newShipments

      void newShipments(Id notificationId, IdList shipmentIds)
      The callback for notifications of new shipments.
      Parameters:
      notificationId - the notification Id
      shipmentIds - the Id of the new Shipments
      Compliance:
      mandatory - This method must be implemented.

    • changedShipments

      void changedShipments(Id notificationId, IdList shipmentIds)
      The callback for notification of updated shipments.
      Parameters:
      notificationId - the notification Id
      shipmentIds - the Id of the updated Shipments
      Compliance:
      mandatory - This method must be implemented.

    • deletedShipments

      void deletedShipments(Id notificationId, IdList shipmentIds)
      the callback for notification of deleted shipments.
      Parameters:
      notificationId - the notification Id
      shipmentIds - the Id of the deleted Shipments
      Compliance:
      mandatory - This method must be implemented.