OrderStatusHistoryRepositoryInterface.php 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Sales\Api;
  7. /**
  8. * Order status history repository interface.
  9. *
  10. * An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product
  11. * items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as
  12. * a purchase order, is emailed to the customer.
  13. * @api
  14. * @since 100.0.2
  15. */
  16. interface OrderStatusHistoryRepositoryInterface
  17. {
  18. /**
  19. * Lists order status history comments that match specified search criteria.
  20. *
  21. * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria The search criteria.
  22. * @return \Magento\Sales\Api\Data\OrderStatusHistorySearchResultInterface Order status history
  23. * search result interface.
  24. */
  25. public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
  26. /**
  27. * Loads a specified order status comment.
  28. *
  29. * @param int $id The order status comment ID.
  30. * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface Order status history interface.
  31. */
  32. public function get($id);
  33. /**
  34. * Deletes a specified order status comment.
  35. *
  36. * @param \Magento\Sales\Api\Data\OrderStatusHistoryInterface $entity The order status comment.
  37. * @return bool
  38. * @throws \Magento\Framework\Exception\CouldNotDeleteException
  39. */
  40. public function delete(\Magento\Sales\Api\Data\OrderStatusHistoryInterface $entity);
  41. /**
  42. * Performs persist operations for a specified order status comment.
  43. *
  44. * @param \Magento\Sales\Api\Data\OrderStatusHistoryInterface $entity The order status comment.
  45. * @return \Magento\Sales\Api\Data\OrderStatusHistoryInterface Order status history interface.
  46. * @throws \Magento\Framework\Exception\CouldNotSaveException
  47. */
  48. public function save(\Magento\Sales\Api\Data\OrderStatusHistoryInterface $entity);
  49. }