BatchInterface.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. <?php
  2. /**
  3. * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
  4. */
  5. namespace Temando\Shipping\Model;
  6. /**
  7. * Temando Batch Interface.
  8. *
  9. * The batch data object represents one item in the batches
  10. * grid listing or on the batch details page.
  11. *
  12. * @package Temando\Shipping\Model
  13. * @author Rhodri Davies <rhodri.davies@temando.com>
  14. * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  15. * @link http://www.temando.com/
  16. */
  17. interface BatchInterface
  18. {
  19. const BATCH_ID = 'batch_id';
  20. const STATUS = 'status';
  21. const CREATED_AT_DATE = 'created_at_date';
  22. const UPDATED_AT_DATE = 'updated_at_date';
  23. const INCLUDED_SHIPMENTS = 'included_shipments';
  24. const FAILED_SHIPMENTS = 'failed_shipments';
  25. const DOCUMENTATION = 'documentation';
  26. /**
  27. * @return string
  28. */
  29. public function getBatchId();
  30. /**
  31. * @return string
  32. */
  33. public function getStatus();
  34. /**
  35. * @return string
  36. */
  37. public function getCreatedAtDate();
  38. /**
  39. * @return string
  40. */
  41. public function getUpdatedAtDate();
  42. /**
  43. * @return \Temando\Shipping\Model\Shipment\ShipmentSummaryInterface[]
  44. */
  45. public function getIncludedShipments();
  46. /**
  47. * @return \Temando\Shipping\Model\Shipment\ShipmentSummaryInterface[]
  48. */
  49. public function getFailedShipments();
  50. /**
  51. * @return string
  52. */
  53. public function getDocumentation();
  54. }