ShipmentReferenceInterface.php 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. <?php
  2. /**
  3. * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
  4. */
  5. namespace Temando\Shipping\Api\Data\Shipment;
  6. /**
  7. * Shipment Reference Interface.
  8. *
  9. * A shipment reference represents the link between local shipment and
  10. * a shipment entity at the Temando platform.
  11. *
  12. * @api
  13. * @package Temando\Shipping\Api
  14. * @author Christoph Aßmann <christoph.assmann@netresearch.de>
  15. * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  16. * @link http://www.temando.com/
  17. */
  18. interface ShipmentReferenceInterface
  19. {
  20. const ENTITY_ID = 'entity_id';
  21. const SHIPMENT_ID = 'shipment_id';
  22. const EXT_SHIPMENT_ID = 'ext_shipment_id';
  23. const EXT_RETURN_SHIPMENT_ID = 'ext_return_shipment_id';
  24. const EXT_LOCATION_ID = 'ext_location_id';
  25. const EXT_TRACKING_URL = 'ext_tracking_url';
  26. const EXT_TRACKING_REFERENCE = 'ext_tracking_reference';
  27. /**
  28. * @return int
  29. */
  30. public function getEntityId();
  31. /**
  32. * @param int $entityId
  33. * @return void
  34. */
  35. public function setEntityId($entityId);
  36. /**
  37. * @return int
  38. */
  39. public function getShipmentId();
  40. /**
  41. * @param int $shipmentId
  42. * @return void
  43. */
  44. public function setShipmentId($shipmentId);
  45. /**
  46. * @return string
  47. */
  48. public function getExtShipmentId();
  49. /**
  50. * @param string $extShipmentId
  51. * @return void
  52. */
  53. public function setExtShipmentId($extShipmentId);
  54. /**
  55. * @return string
  56. */
  57. public function getExtReturnShipmentId();
  58. /**
  59. * @param string $extReturnShipmentId
  60. * @return void
  61. */
  62. public function setExtReturnShipmentId($extReturnShipmentId);
  63. /**
  64. * @return string
  65. */
  66. public function getExtLocationId();
  67. /**
  68. * @param string $extLocationId
  69. * @return void
  70. */
  71. public function setExtLocationId($extLocationId);
  72. /**
  73. * @return string
  74. */
  75. public function getExtTrackingUrl();
  76. /**
  77. * @param string $extTrackingUrl
  78. * @return void
  79. */
  80. public function setExtTrackingUrl($extTrackingUrl);
  81. /**
  82. * @return string
  83. */
  84. public function getExtTrackingReference();
  85. /**
  86. * @param string $extTrackingReference
  87. * @return void
  88. */
  89. public function setExtTrackingReference($extTrackingReference);
  90. }