org.broadleafcommerce.common.extension.currency

Interface CurrencyResolverExtensionHandler

All Superinterfaces:

ExtensionHandler

All Known Implementing Classes:

AbstractCurrencyResolverExtensionHandler

public interface CurrencyResolverExtensionHandler
extends ExtensionHandler

Implementors of this interface can override the currency that will be resolved by the BroadleafCurrencyResolver. A default, community implementation of Broadleaf will support a single currency. If additional currencies are added (either by inclusion of enterprise pricing modules) or with custom development, then an implementation of this handler can be provided that allows the request to be associated with an alternate currency. All implementors of this interface should extend the AbstractCurrencyResolverExtensionHandler where possible.

Author:

bpolster

Method Summary

Methods

Modifier and Type	Method and Description
ExtensionResultStatusType	overrideCurrency(BroadleafCurrency desiredCurrency, BroadleafCurrency defaultCurrency, ExtensionResultHolder<BroadleafCurrency> currencyToUse) Implementation sets the ExtensionResultHolder value to the currency that should be used.

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Method Detail

overrideCurrency

ExtensionResultStatusType overrideCurrency(BroadleafCurrency desiredCurrency,
                                         BroadleafCurrency defaultCurrency,
                                         ExtensionResultHolder<BroadleafCurrency> currencyToUse)

Implementation sets the ExtensionResultHolder value to the currency that should be used. Setting to null will force the currency resolver to utilize the defaultCurrency. Note that implementations run in ExtensionHandler.getPriority() order and the last one wins. Also note that prior implementations may have set the value on the ExtensionResultHolder. Later implementations are free to alter but should do so with clear intent to override.

Parameters:

desiredCurrency -

defaultCurrency -

Returns: