PriceUpdateResultInterface.php 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Catalog\Api\Data;
  7. /**
  8. * Interface returned in case of incorrect price passed to efficient price API.
  9. * @api
  10. * @since 102.0.0
  11. */
  12. interface PriceUpdateResultInterface extends \Magento\Framework\Api\ExtensibleDataInterface
  13. {
  14. /**#@+
  15. * Constants
  16. */
  17. const MESSAGE = 'message';
  18. const PARAMETERS = 'parameters';
  19. /**#@-*/
  20. /**
  21. * Get error message, that contains description of error occurred during price update.
  22. *
  23. * @return string
  24. * @since 102.0.0
  25. */
  26. public function getMessage();
  27. /**
  28. * Set error message, that contains description of error occurred during price update.
  29. *
  30. * @param string $message
  31. * @return $this
  32. * @since 102.0.0
  33. */
  34. public function setMessage($message);
  35. /**
  36. * Get parameters, that could be displayed in error message placeholders.
  37. *
  38. * @return string[]
  39. * @since 102.0.0
  40. */
  41. public function getParameters();
  42. /**
  43. * Set parameters, that could be displayed in error message placeholders.
  44. *
  45. * @param string[] $parameters
  46. * @return $this
  47. * @since 102.0.0
  48. */
  49. public function setParameters(array $parameters);
  50. /**
  51. * Retrieve existing extension attributes object.
  52. * If extension attributes do not exist return null.
  53. *
  54. * @return \Magento\Catalog\Api\Data\PriceUpdateResultExtensionInterface|null
  55. * @since 102.0.0
  56. */
  57. public function getExtensionAttributes();
  58. /**
  59. * Set an extension attributes object.
  60. *
  61. * @param \Magento\Catalog\Api\Data\PriceUpdateResultExtensionInterface $extensionAttributes
  62. * @return $this
  63. * @since 102.0.0
  64. */
  65. public function setExtensionAttributes(
  66. \Magento\Catalog\Api\Data\PriceUpdateResultExtensionInterface $extensionAttributes
  67. );
  68. }