PendingRefundInterface.php 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  1. <?php
  2. /**
  3. * Copyright 2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License").
  6. * You may not use this file except in compliance with the License.
  7. * A copy of the License is located at
  8. *
  9. * http://aws.amazon.com/apache2.0
  10. *
  11. * or in the "license" file accompanying this file. This file is distributed
  12. * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  13. * express or implied. See the License for the specific language governing
  14. * permissions and limitations under the License.
  15. */
  16. namespace Amazon\Payment\Api\Data;
  17. use Amazon\Payment\Model\ResourceModel\PendingRefund as PendingRefundResource;
  18. /**
  19. * @api
  20. */
  21. interface PendingRefundInterface
  22. {
  23. const ID = 'entity_id';
  24. const REFUND_ID = 'refund_id';
  25. const ORDER_ID = 'order_id';
  26. const PAYMENT_ID = 'payment_id';
  27. const CREATED_AT = 'created_at';
  28. /**
  29. * @return integer
  30. */
  31. public function getId();
  32. /**
  33. * @return string
  34. */
  35. public function getRefundId();
  36. /**
  37. * @param string $refundId
  38. * @return $this
  39. */
  40. public function setRefundId($refundId);
  41. /**
  42. * @return integer
  43. */
  44. public function getPaymentId();
  45. /**
  46. * @param integer $paymentId
  47. * @return $this
  48. */
  49. public function setPaymentId($paymentId);
  50. /**
  51. * @return integer
  52. */
  53. public function getOrderId();
  54. /**
  55. * @param integer $orderId
  56. * @return $this
  57. */
  58. public function setOrderId($orderId);
  59. /**
  60. * @return string
  61. */
  62. public function getCreatedAt();
  63. /**
  64. * @param string $createdAt
  65. * @return $this
  66. */
  67. public function setCreatedAt($createdAt);
  68. /**
  69. * @return $this
  70. * @throws \Exception
  71. */
  72. public function save();
  73. /**
  74. * @return $this
  75. * @throws \Exception
  76. */
  77. public function delete();
  78. /**
  79. * @param integer $modelId
  80. * @param null|string $field
  81. * @return $this
  82. */
  83. public function load($modelId, $field = null);
  84. /**
  85. * Set whether to lock db record on load
  86. *
  87. * @param boolean $lockOnLoad
  88. * @return $this
  89. */
  90. public function setLockOnLoad($lockOnLoad);
  91. /**
  92. * Get whether to lock db record on load
  93. *
  94. * @return boolean
  95. */
  96. public function hasLockOnLoad();
  97. /**
  98. * @return PendingRefundResource
  99. */
  100. public function getResource();
  101. }