org.broadleafcommerce.common.extension.currency

Class AbstractCurrencyResolverExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.common.extension.currency.AbstractCurrencyResolverExtensionHandler

All Implemented Interfaces:

CurrencyResolverExtensionHandler, ExtensionHandler

public class AbstractCurrencyResolverExtensionHandler
extends AbstractExtensionHandler
implements CurrencyResolverExtensionHandler

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.

Author:

bpolster

Field Summary

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor and Description
AbstractCurrencyResolverExtensionHandler()

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 class org.broadleafcommerce.common.extension.AbstractExtensionHandler

getPriority, isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

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

getPriority, isEnabled

Constructor Detail

AbstractCurrencyResolverExtensionHandler

public AbstractCurrencyResolverExtensionHandler()

Method Detail

overrideCurrency

public 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 AbstractExtensionHandler.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.

Specified by:

overrideCurrency in interface CurrencyResolverExtensionHandler

Parameters:

desiredCurrency -

defaultCurrency -

Returns: