CurrencyInformationInterface.php 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Directory\Api\Data;
  7. /**
  8. * Currency Information interface.
  9. *
  10. * @api
  11. * @since 100.0.2
  12. */
  13. interface CurrencyInformationInterface extends \Magento\Framework\Api\ExtensibleDataInterface
  14. {
  15. /**
  16. * Get the base currency code for the store.
  17. *
  18. * @return string
  19. */
  20. public function getBaseCurrencyCode();
  21. /**
  22. * Set the base currency code for the store.
  23. *
  24. * @param string $code
  25. * @return $this
  26. */
  27. public function setBaseCurrencyCode($code);
  28. /**
  29. * Get the currency symbol of the base currency for the store.
  30. *
  31. * @return string
  32. */
  33. public function getBaseCurrencySymbol();
  34. /**
  35. * Set the currency symbol of the base currency for the store.
  36. *
  37. * @param string $symbol
  38. * @return $this
  39. */
  40. public function setBaseCurrencySymbol($symbol);
  41. /**
  42. * Get the default display currency code for the store.
  43. *
  44. * @return string
  45. */
  46. public function getDefaultDisplayCurrencyCode();
  47. /**
  48. * Set the default display currency code for the store.
  49. *
  50. * @param string $code
  51. * @return $this
  52. */
  53. public function setDefaultDisplayCurrencyCode($code);
  54. /**
  55. * Get the currency symbol of the default display currency for the store.
  56. *
  57. * @return string
  58. */
  59. public function getDefaultDisplayCurrencySymbol();
  60. /**
  61. * Set the currency symbol of the default display currency for the store.
  62. *
  63. * @param string $symbol
  64. * @return $this
  65. */
  66. public function setDefaultDisplayCurrencySymbol($symbol);
  67. /**
  68. * Get the list of allowed currency codes for the store.
  69. *
  70. * @return string[]
  71. */
  72. public function getAvailableCurrencyCodes();
  73. /**
  74. * Set the list of allowed currency codes for the store.
  75. *
  76. * @param string[] $codes
  77. * @return $this
  78. */
  79. public function setAvailableCurrencyCodes(array $codes = null);
  80. /**
  81. * Get the list of exchange rate information for the store.
  82. *
  83. * @return \Magento\Directory\Api\Data\ExchangeRateInterface[]
  84. */
  85. public function getExchangeRates();
  86. /**
  87. * Set the list of exchange rate information for the store.
  88. *
  89. * @param \Magento\Directory\Api\Data\ExchangeRateInterface[] $exchangeRates
  90. * @return $this
  91. */
  92. public function setExchangeRates(array $exchangeRates = null);
  93. /**
  94. * Retrieve existing extension attributes object or create a new one.
  95. *
  96. * @return \Magento\Directory\Api\Data\CurrencyInformationExtensionInterface|null
  97. */
  98. public function getExtensionAttributes();
  99. /**
  100. * Set an extension attributes object.
  101. *
  102. * @param \Magento\Directory\Api\Data\CurrencyInformationExtensionInterface $extensionAttributes
  103. * @return $this
  104. */
  105. public function setExtensionAttributes(
  106. \Magento\Directory\Api\Data\CurrencyInformationExtensionInterface $extensionAttributes
  107. );
  108. }