Package com.broadleafcommerce.cartoperation.service

Class CartOperationServiceProperties

java.lang.Object
com.broadleafcommerce.cartoperation.service.CartOperationServiceProperties
@ConfigurationProperties("broadleaf.cartoperation.service") public class CartOperationServiceProperties extends Object

  • Constructor Details

    • CartOperationServiceProperties

      public CartOperationServiceProperties()

  • Method Details

    • isFailConfigErrorOnAdd

      public boolean isFailConfigErrorOnAdd()
      If there is a configuration error for a cart item when attempting to add it to a cart, fail the attempt. This need to "fail fast" might be required if there isn't a good way to fix the configuration errors after adding to cart.

    • isCalculateFulfillmentPricingWithAdjustments

      public boolean isCalculateFulfillmentPricingWithAdjustments()
      Whether the fulfillment pricing should consider the adjustments on the order and order items.

    • isCalculateProratedFulfillmentPricing

      public boolean isCalculateProratedFulfillmentPricing()
      Whether the fulfillment pricing should consider prorated price of the order items, after factoring in the order adjustments.

    • getDefaultVirtualFulfillmentOptionName

      public String getDefaultVirtualFulfillmentOptionName()
      The default fulfillment option name for the FulfillmentType.VIRTUAL fulfillment type.

    • getMergingType

      public String getMergingType()
      Globally determines how Products should merge with other similar items when they get added to a cart. Will be overridden by merge values on a Product. Out of box supported values are those in DefaultMergingType.

    • getPriceInvalidation

      public CartOperationServiceProperties.PriceInvalidation getPriceInvalidation()
      The price invalidation configuration. Controls when prices on a cart or its items are considered invalid when clients use certain API operations.

    • getBulkAddToCartOperation

      public CartOperationServiceProperties.BulkAddToCartOperation getBulkAddToCartOperation()
      The bulk properties configuration.

    • getItemListSecurity

      public CartOperationServiceProperties.ItemListSecurity getItemListSecurity()

    • getCartApproval

      public CartOperationServiceProperties.CartApproval getCartApproval()
      The cart approval configuration.

    • getCartPricingTimeToLive

      public Duration getCartPricingTimeToLive()
      The amount of time before the cart's pricing is considered stale. Once this duration is exceeded, the cart will be fully repriced on its next retrieval.

    • getOfferServicesVersion

      public String getOfferServicesVersion()
      The offer version enabled for external service calls with CartOperationService. This is useful for maintaining backwards compatibility. If using the latest version, this property does not have to be supplied.

    • isMatchCartItemAssetToVariant

      @Deprecated public boolean isMatchCartItemAssetToVariant()
      Deprecated.
      since 1.7.3, in favor of CartItemProductServiceProperties.isMatchCartItemAssetToVariant()
      Determines whether the CartItem.getImageAsset() should match the selected Variant if possible instead of the Product.getPrimaryAsset(). The matching will be done via DefaultCartItemCatalogInformationService if the Variant has optionValues to use to match with a product asset by tag.

    • isSwitchCurrencyOnLocaleSwitch

      public boolean isSwitchCurrencyOnLocaleSwitch()
      When repricing cart, if a new locale has been requested, automatically switch to the default currency for that locale.

    • isUpdateCatalogPricingOnCurrencyChange

      public boolean isUpdateCatalogPricingOnCurrencyChange()
      When repricing cart, if the currency changes, force an update to catalog pricing.

    • isLegacyUpdateCartStatusEnabled

      public boolean isLegacyUpdateCartStatusEnabled()
      If true, the deprecated CartOperationService.updateCartStatus(Cart, UpdateCartStatusRequest, ContextInfo) method will be used to update the Cart status.

      This property should be set to true only if there are specific needs to do so, for example, for backward compatibility if the new CartOperationService.updateCartStatus(Cart, UpdateCartStatusRequest, CustomerRef, ContextInfo) method causes any issues and can't be updated/fixed immediately.

    • setFailConfigErrorOnAdd

      public void setFailConfigErrorOnAdd(boolean failConfigErrorOnAdd)
      If there is a configuration error for a cart item when attempting to add it to a cart, fail the attempt. This need to "fail fast" might be required if there isn't a good way to fix the configuration errors after adding to cart.

    • setCalculateFulfillmentPricingWithAdjustments

      public void setCalculateFulfillmentPricingWithAdjustments(boolean calculateFulfillmentPricingWithAdjustments)
      Whether the fulfillment pricing should consider the adjustments on the order and order items.

    • setCalculateProratedFulfillmentPricing

      public void setCalculateProratedFulfillmentPricing(boolean calculateProratedFulfillmentPricing)
      Whether the fulfillment pricing should consider prorated price of the order items, after factoring in the order adjustments.

    • setDefaultVirtualFulfillmentOptionName

      public void setDefaultVirtualFulfillmentOptionName(String defaultVirtualFulfillmentOptionName)
      The default fulfillment option name for the FulfillmentType.VIRTUAL fulfillment type.

    • setMergingType

      public void setMergingType(String mergingType)
      Globally determines how Products should merge with other similar items when they get added to a cart. Will be overridden by merge values on a Product. Out of box supported values are those in DefaultMergingType.

    • setPriceInvalidation

      public void setPriceInvalidation(CartOperationServiceProperties.PriceInvalidation priceInvalidation)
      The price invalidation configuration. Controls when prices on a cart or its items are considered invalid when clients use certain API operations.

    • setBulkAddToCartOperation

      public void setBulkAddToCartOperation(CartOperationServiceProperties.BulkAddToCartOperation bulkAddToCartOperation)
      The bulk properties configuration.

    • setItemListSecurity

      public void setItemListSecurity(CartOperationServiceProperties.ItemListSecurity itemListSecurity)

    • setCartApproval

      public void setCartApproval(CartOperationServiceProperties.CartApproval cartApproval)
      The cart approval configuration.

    • setCartPricingTimeToLive

      public void setCartPricingTimeToLive(Duration cartPricingTimeToLive)
      The amount of time before the cart's pricing is considered stale. Once this duration is exceeded, the cart will be fully repriced on its next retrieval.

    • setOfferServicesVersion

      public void setOfferServicesVersion(String offerServicesVersion)
      The offer version enabled for external service calls with CartOperationService. This is useful for maintaining backwards compatibility. If using the latest version, this property does not have to be supplied.

    • setMatchCartItemAssetToVariant

      @Deprecated public void setMatchCartItemAssetToVariant(boolean matchCartItemAssetToVariant)
      Deprecated.
      since 1.7.3, in favor of CartItemProductServiceProperties.isMatchCartItemAssetToVariant()
      Determines whether the CartItem.getImageAsset() should match the selected Variant if possible instead of the Product.getPrimaryAsset(). The matching will be done via DefaultCartItemCatalogInformationService if the Variant has optionValues to use to match with a product asset by tag.

    • setSwitchCurrencyOnLocaleSwitch

      public void setSwitchCurrencyOnLocaleSwitch(boolean switchCurrencyOnLocaleSwitch)
      When repricing cart, if a new locale has been requested, automatically switch to the default currency for that locale.

    • setUpdateCatalogPricingOnCurrencyChange

      public void setUpdateCatalogPricingOnCurrencyChange(boolean updateCatalogPricingOnCurrencyChange)
      When repricing cart, if the currency changes, force an update to catalog pricing.

    • setLegacyUpdateCartStatusEnabled

      public void setLegacyUpdateCartStatusEnabled(boolean legacyUpdateCartStatusEnabled)
      If true, the deprecated CartOperationService.updateCartStatus(Cart, UpdateCartStatusRequest, ContextInfo) method will be used to update the Cart status.

      This property should be set to true only if there are specific needs to do so, for example, for backward compatibility if the new CartOperationService.updateCartStatus(Cart, UpdateCartStatusRequest, CustomerRef, ContextInfo) method causes any issues and can't be updated/fixed immediately.