ShipmentProviderInterface.php 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. <?php
  2. /**
  3. * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
  4. */
  5. namespace Temando\Shipping\Model\Shipment;
  6. use Magento\Sales\Api\Data\ShipmentInterface as SalesShipmentInterface;
  7. use Temando\Shipping\Model\ShipmentInterface;
  8. /**
  9. * Temando Shipment Provider Interface.
  10. *
  11. * Provide a shipment entity fetched from the platform for re-use in the current
  12. * request cycle.
  13. *
  14. * @package Temando\Shipping\Model
  15. * @author Benjamin Heuer <benjamin.heuer@netresearch.de>
  16. * @license https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  17. * @link https://www.temando.com/
  18. */
  19. interface ShipmentProviderInterface
  20. {
  21. /**
  22. * @return ShipmentInterface
  23. */
  24. public function getShipment(): ?ShipmentInterface;
  25. /**
  26. * @param ShipmentInterface $shipment
  27. *
  28. * @return void
  29. */
  30. public function setShipment(ShipmentInterface $shipment): void;
  31. /**
  32. * @return SalesShipmentInterface
  33. */
  34. public function getSalesShipment(): ?SalesShipmentInterface;
  35. /**
  36. * @param SalesShipmentInterface $shipment
  37. *
  38. * @return void
  39. */
  40. public function setSalesShipment(SalesShipmentInterface $shipment): void;
  41. }