ShipmentErrorInterface.php 1.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  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. /**
  7. * Temando Shipment Error Interface.
  8. *
  9. * Error as occurred during allocation, dispatch, or batch processes.
  10. *
  11. * @package Temando\Shipping\Model
  12. * @author Christoph Aßmann <christoph.assmann@netresearch.de>
  13. * @license https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  14. * @link https://www.temando.com/
  15. */
  16. interface ShipmentErrorInterface
  17. {
  18. const STATUS = 'status';
  19. const TITLE = 'title';
  20. const CODE = 'code';
  21. const DETAIL = 'detail';
  22. /**
  23. * Get error status
  24. *
  25. * @return string
  26. */
  27. public function getStatus();
  28. /**
  29. * Get error title
  30. *
  31. * @return string
  32. */
  33. public function getTitle();
  34. /**
  35. * Get error code
  36. *
  37. * @return string
  38. */
  39. public function getCode();
  40. /**
  41. * Get error detail (optional)
  42. *
  43. * @return string
  44. */
  45. public function getDetail();
  46. }