CommentInterface.php 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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. /**
  8. * Interface CommentInterface
  9. *
  10. * @api
  11. * @since 100.1.2
  12. */
  13. interface CommentInterface
  14. {
  15. /*
  16. * Is-visible-on-storefront flag.
  17. */
  18. const IS_VISIBLE_ON_FRONT = 'is_visible_on_front';
  19. /*
  20. * Comment.
  21. */
  22. const COMMENT = 'comment';
  23. /**
  24. * Gets the comment text.
  25. *
  26. * @return string Comment.
  27. * @since 100.1.2
  28. */
  29. public function getComment();
  30. /**
  31. * Sets the comment text.
  32. *
  33. * @param string $comment
  34. * @return $this
  35. * @since 100.1.2
  36. */
  37. public function setComment($comment);
  38. /**
  39. * Gets the is-visible-on-storefront flag value for the comment.
  40. *
  41. * @return int Is-visible-on-storefront flag value.
  42. * @since 100.1.2
  43. */
  44. public function getIsVisibleOnFront();
  45. /**
  46. * Sets the is-visible-on-storefront flag value for the comment.
  47. *
  48. * @param int $isVisibleOnFront
  49. * @return $this
  50. * @since 100.1.2
  51. */
  52. public function setIsVisibleOnFront($isVisibleOnFront);
  53. }