StreamEventInterface.php 1.2 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;
  6. /**
  7. * Temando Event Interface.
  8. *
  9. * The event data object represents one item in the event stream for shipments to modify (CRUD)
  10. *
  11. * @package Temando\Shipping\Model
  12. * @author Benjamin Heuer <benjamin.heuer@netresearch.de>
  13. * @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  14. * @link http://www.temando.com/
  15. */
  16. interface StreamEventInterface
  17. {
  18. const EVENT_ID = 'event_id';
  19. const EVENT_TYPE = 'event_type';
  20. const ENTITY_TYPE = 'entity_type';
  21. const ENTITY_ID = 'entity_id';
  22. const EVENT_TYPE_CREATE = 'CREATE';
  23. const EVENT_TYPE_MODIFY = 'MODIFY';
  24. const EVENT_TYPE_REMOVE = 'REMOVE';
  25. const ENTITY_TYPE_ORDER = 'order';
  26. const ENTITY_TYPE_SHIPMENT = 'shipment';
  27. /**
  28. * @return string
  29. */
  30. public function getEventId();
  31. /**
  32. * @return string
  33. */
  34. public function getEventType();
  35. /**
  36. * @return string
  37. */
  38. public function getEntityType();
  39. /**
  40. * @return string
  41. */
  42. public function getEntityId();
  43. }