OrderPaymentRepositoryInterface.php 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  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 payment 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 OrderPaymentRepositoryInterface
  17. {
  18. /**
  19. * Lists order payments that match specified search criteria.
  20. *
  21. * @param \Magento\Framework\Api\SearchCriteriaInterface $searchCriteria The search criteria.
  22. * @return \Magento\Sales\Api\Data\OrderPaymentSearchResultInterface Order payment search result interface.
  23. */
  24. public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
  25. /**
  26. * Loads a specified order payment.
  27. *
  28. * @param int $id The order payment ID.
  29. * @return \Magento\Sales\Api\Data\OrderPaymentInterface Order payment interface.
  30. */
  31. public function get($id);
  32. /**
  33. * Deletes a specified order payment.
  34. *
  35. * @param \Magento\Sales\Api\Data\OrderPaymentInterface $entity The order payment ID.
  36. * @return bool
  37. */
  38. public function delete(\Magento\Sales\Api\Data\OrderPaymentInterface $entity);
  39. /**
  40. * Performs persist operations for a specified order payment.
  41. *
  42. * @param \Magento\Sales\Api\Data\OrderPaymentInterface $entity The order payment ID.
  43. * @return \Magento\Sales\Api\Data\OrderPaymentInterface Order payment interface.
  44. */
  45. public function save(\Magento\Sales\Api\Data\OrderPaymentInterface $entity);
  46. /**
  47. * Creates new Order Payment instance.
  48. *
  49. * @return \Magento\Sales\Api\Data\OrderPaymentInterface Transaction interface.
  50. */
  51. public function create();
  52. }