Package com.broadleafcommerce.pricing.service.autoconfigure

Class PriceInfoProperties

java.lang.Object
com.broadleafcommerce.pricing.service.autoconfigure.PriceInfoProperties
@ConfigurationProperties("broadleaf.pricing.price-info") public class PriceInfoProperties extends Object
Configuration properties related to the behaviors of retrieving price infos.
Since:
Pricing Services 2.2.0, Release Train 2.3.0
Author:
Sunny Yu

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected boolean
    addCurrencyConversionDetails
    When this is true, the system will add additional details about what the converted prices would look like in a separate Map, PriceInfo.getConvertedPriceTypeDetails().
    protected boolean
    allowMergingTermFrequencyAcrossPriceLists
    Whether to allow merging of price data with different terms or frequencies across different price lists of the same type.
    protected boolean
    preferContractPrices
    When this is true, the contract price will be preferred over lower standard or sales prices.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PriceInfoProperties()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isAddCurrencyConversionDetails()
    When this is true, the system will add additional details about what the converted prices would look like in a separate Map, PriceInfo.getConvertedPriceTypeDetails().
    boolean
    isAllowMergingTermFrequencyAcrossPriceLists()
    Whether to allow merging of price data with different terms or frequencies across different price lists of the same type.
    boolean
    isPreferContractPrices()
    When this is true, the contract price will be preferred over lower standard or sales prices.
    void
    setAddCurrencyConversionDetails(boolean addCurrencyConversionDetails)
    When this is true, the system will add additional details about what the converted prices would look like in a separate Map, PriceInfo.getConvertedPriceTypeDetails().
    void
    setAllowMergingTermFrequencyAcrossPriceLists(boolean allowMergingTermFrequencyAcrossPriceLists)
    Whether to allow merging of price data with different terms or frequencies across different price lists of the same type.
    void
    setPreferContractPrices(boolean preferContractPrices)
    When this is true, the contract price will be preferred over lower standard or sales prices.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • allowMergingTermFrequencyAcrossPriceLists

      protected boolean allowMergingTermFrequencyAcrossPriceLists
      Whether to allow merging of price data with different terms or frequencies across different price lists of the same type.

      For example, consider 2 standard PriceLists, A and B, each with a PriceData targeting the same SKU. PriceListA has a priority of 1, and its PriceData defines a recurring price of $10 per month for a year. PriceListB has a priority of 10, and its PriceData defines a recurring price of $8 per month for 2 years. If this property is true, PriceInfos will be built for both PriceData. Conversely, when set to false, PriceInfos will only be built for PriceListA's PriceData, since it has a higher priority.

    • addCurrencyConversionDetails

      protected boolean addCurrencyConversionDetails
      When this is true, the system will add additional details about what the converted prices would look like in a separate Map, PriceInfo.getConvertedPriceTypeDetails(). Note that the PriceInfo itself still has the original unconverted prices.

      These values contain the best price of each type converted via an exchange rate to a preferred currency, which is relevant when no price data is configured for that currency.

    • preferContractPrices

      protected boolean preferContractPrices
      When this is true, the contract price will be preferred over lower standard or sales prices.

      Since:
      Pricing Services 2.2.0, Release Train 2.3.0

  • Constructor Details

    • PriceInfoProperties

      public PriceInfoProperties()

  • Method Details

    • isAllowMergingTermFrequencyAcrossPriceLists

      public boolean isAllowMergingTermFrequencyAcrossPriceLists()
      Whether to allow merging of price data with different terms or frequencies across different price lists of the same type.

      For example, consider 2 standard PriceLists, A and B, each with a PriceData targeting the same SKU. PriceListA has a priority of 1, and its PriceData defines a recurring price of $10 per month for a year. PriceListB has a priority of 10, and its PriceData defines a recurring price of $8 per month for 2 years. If this property is true, PriceInfos will be built for both PriceData. Conversely, when set to false, PriceInfos will only be built for PriceListA's PriceData, since it has a higher priority.

    • isAddCurrencyConversionDetails

      public boolean isAddCurrencyConversionDetails()
      When this is true, the system will add additional details about what the converted prices would look like in a separate Map, PriceInfo.getConvertedPriceTypeDetails(). Note that the PriceInfo itself still has the original unconverted prices.

      These values contain the best price of each type converted via an exchange rate to a preferred currency, which is relevant when no price data is configured for that currency.

    • isPreferContractPrices

      public boolean isPreferContractPrices()
      When this is true, the contract price will be preferred over lower standard or sales prices.

      Since:
      Pricing Services 2.2.0, Release Train 2.3.0

    • setAllowMergingTermFrequencyAcrossPriceLists

      public void setAllowMergingTermFrequencyAcrossPriceLists(boolean allowMergingTermFrequencyAcrossPriceLists)
      Whether to allow merging of price data with different terms or frequencies across different price lists of the same type.

      For example, consider 2 standard PriceLists, A and B, each with a PriceData targeting the same SKU. PriceListA has a priority of 1, and its PriceData defines a recurring price of $10 per month for a year. PriceListB has a priority of 10, and its PriceData defines a recurring price of $8 per month for 2 years. If this property is true, PriceInfos will be built for both PriceData. Conversely, when set to false, PriceInfos will only be built for PriceListA's PriceData, since it has a higher priority.

    • setAddCurrencyConversionDetails

      public void setAddCurrencyConversionDetails(boolean addCurrencyConversionDetails)
      When this is true, the system will add additional details about what the converted prices would look like in a separate Map, PriceInfo.getConvertedPriceTypeDetails(). Note that the PriceInfo itself still has the original unconverted prices.

      These values contain the best price of each type converted via an exchange rate to a preferred currency, which is relevant when no price data is configured for that currency.

    • setPreferContractPrices

      public void setPreferContractPrices(boolean preferContractPrices)
      When this is true, the contract price will be preferred over lower standard or sales prices.

      Since:
      Pricing Services 2.2.0, Release Train 2.3.0