InvoiceCommentInterface.php 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Sales\Api\Data;
  7. use Magento\Framework\Api\ExtensibleDataInterface;
  8. /**
  9. * Invoice comment interface.
  10. *
  11. * An invoice is a record of the receipt of payment for an order. An invoice can include comments that detail the
  12. * invoice history.
  13. * @api
  14. * @since 100.0.2
  15. */
  16. interface InvoiceCommentInterface extends ExtensibleDataInterface, CommentInterface, EntityInterface
  17. {
  18. /**#@+
  19. * Constants for keys of data array. Identical to the name of the getter in snake case.
  20. */
  21. /*
  22. * Parent ID.
  23. */
  24. const PARENT_ID = 'parent_id';
  25. /*
  26. * Is-customer-notified flag.
  27. */
  28. const IS_CUSTOMER_NOTIFIED = 'is_customer_notified';
  29. /**
  30. * Gets the is-customer-notified flag value for the invoice.
  31. *
  32. * @return int Is-customer-notified flag value.
  33. */
  34. public function getIsCustomerNotified();
  35. /**
  36. * Gets the parent ID for the invoice.
  37. *
  38. * @return int Parent ID.
  39. */
  40. public function getParentId();
  41. /**
  42. * Sets the parent ID for the invoice.
  43. *
  44. * @param int $id
  45. * @return $this
  46. */
  47. public function setParentId($id);
  48. /**
  49. * Sets the is-customer-notified flag value for the invoice.
  50. *
  51. * @param int $isCustomerNotified
  52. * @return $this
  53. */
  54. public function setIsCustomerNotified($isCustomerNotified);
  55. /**
  56. * Retrieve existing extension attributes object or create a new one.
  57. *
  58. * @return \Magento\Sales\Api\Data\InvoiceCommentExtensionInterface|null
  59. */
  60. public function getExtensionAttributes();
  61. /**
  62. * Set an extension attributes object.
  63. *
  64. * @param \Magento\Sales\Api\Data\InvoiceCommentExtensionInterface $extensionAttributes
  65. * @return $this
  66. */
  67. public function setExtensionAttributes(
  68. \Magento\Sales\Api\Data\InvoiceCommentExtensionInterface $extensionAttributes
  69. );
  70. }