Package de.hybris.platform.order.impl

Class DefaultCalculationService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.order.impl.DefaultCalculationService

All Implemented Interfaces:

CalculationService, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class DefaultCalculationService
extends AbstractBusinessService
implements CalculationService

Default implementation of the CalculationService.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor	Description
DefaultCalculationService()

Method Summary

Modifier and Type	Method	Description
protected void	addAbsoluteEntryTaxValue(long entryQuantity, TaxValue taxValue, Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap)
protected void	addRelativeEntryTaxValue(double entryTotal, TaxValue taxValue, Set<TaxValue> relativeEntryTaxValues, Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap)
protected TaxValue	applyGrossMixedRate(TaxValue unappliedTaxValue, Map<Set<TaxValue>,Double> taxGroups, int digits, double taxAdjustmentFactor)
protected TaxValue	applyNetMixedRate(TaxValue unappliedTaxValue, Map<Set<TaxValue>,Double> taxGroups, int digits, double taxAdjustmentFactor)
void	calculate(AbstractOrderModel order)	Calculates the given order and all its entries unless they're already calculated and the order has not been modified.
void	calculate(AbstractOrderModel order, Date date)	Calculates the given order and all its entries unless they're already calculated and the order has not been modified.
protected TaxValue	calculateAbsoluteTotalTaxValue(CurrencyModel curr, String currencyIso, int digits, boolean net, TaxValue taxValue, double cumulatedEntryQuantities)
protected double	calculateDiscountValues(AbstractOrderModel order, boolean recalculate)	Returns the total discount for this abstract order.
void	calculateEntries(AbstractOrderModel order, boolean forceRecalculate)
protected Map<TaxValue,Map<Set<TaxValue>,Double>>	calculateSubtotal(AbstractOrderModel order, boolean recalculate)
void	calculateTotals(AbstractOrderEntryModel entry, boolean recalculate)	Recalculates given entries total prices and re-applies tax and discount values.
void	calculateTotals(AbstractOrderModel order, boolean recalculate)	(re)calculates all totals for the given order.
protected void	calculateTotals(AbstractOrderModel order, boolean recalculate, Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap)	calculates all totals.
protected void	calculateTotalTaxValues(AbstractOrderEntryModel entry)
protected double	calculateTotalTaxValues(AbstractOrderModel order, boolean recalculate, int digits, double taxAdjustmentFactor, Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap)
protected List	convertDiscountValues(AbstractOrderModel order, List dvs)
PriceValue	convertPriceIfNecessary(PriceValue pv, boolean toNet, CurrencyModel toCurrency, Collection taxValues)	converts a PriceValue object into a double matching the target currency and net/gross - state if necessary.
protected PriceValue	findBasePrice(AbstractOrderEntryModel entry)
protected List<DiscountValue>	findDiscountValues(AbstractOrderEntryModel entry)
protected List<DiscountValue>	findGlobalDiscounts(AbstractOrderModel order)
protected Collection<TaxValue>	findTaxValues(AbstractOrderEntryModel entry)
protected double	getTaxCorrectionFactor(Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap, double subtotal, double total, AbstractOrderModel order)
boolean	getTaxFreeEntrySupport()	Deprecated, for removal: This API element is subject to removal in a future version. since ages - useisTaxFreeEntrySupport()
protected double	getTaxFreeSubTotal(AbstractOrderModel order)	Calculates the sub total of all order entries with NO tax values.
protected Set<TaxValue>	getUnappliedRelativeTaxValues(Collection<TaxValue> allTaxValues)
protected boolean	hasJaloStrategies()
protected boolean	isAllEntriesTaxed(Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap, double subtotal, AbstractOrderModel order)
boolean	isTaxFreeEntrySupport()
protected boolean	mustHandleTaxFreeEntries(Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap, double subtotal, AbstractOrderModel order)
void	recalculate(AbstractOrderEntryModel entry)	Calculates this entry even if the entry was calculated before.
void	recalculate(AbstractOrderModel order)	recalculates the whole order and all its entries.
void	recalculate(AbstractOrderModel order, Date date)	recalculates the whole order and all its entries.
protected void	recalculateOrderEntryIfNeeded(AbstractOrderEntryModel entry, boolean forceRecalculation)
protected void	refreshOrder(AbstractOrderModel order)
boolean	requiresCalculation(AbstractOrderModel order)	Return Boolean.TRUE in case if order needs to be calculated.
protected void	resetAdditionalCosts(AbstractOrderModel order, Collection<TaxValue> relativeTaxValues)
protected void	resetAllValues(AbstractOrderEntryModel entry)
protected Map	resetAllValues(AbstractOrderModel order)
protected void	saveOrder(AbstractOrderModel order)
protected void	setCalculatedStatus(AbstractOrderEntryModel entry)
protected void	setCalculatedStatus(AbstractOrderModel order)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setFindDeliveryCostStrategy(FindDeliveryCostStrategy findDeliveryCostStrategy)
void	setFindDiscountsStrategies(List<FindDiscountValuesStrategy> findDiscountsStrategies)
void	setFindPaymentCostStrategy(FindPaymentCostStrategy findPaymentCostStrategy)
void	setFindPriceStrategy(FindPriceStrategy findPriceStrategy)
void	setFindTaxesStrategies(List<FindTaxValuesStrategy> findTaxesStrategies)
void	setOrderRequiresCalculationStrategy(OrderRequiresCalculationStrategy orderRequiresCalculationStrategy)
void	setTaxFreeEntrySupport(boolean taxFreeEntrySupport)

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCalculationService

public DefaultCalculationService()

Method Details

calculate

public void calculate(AbstractOrderModel order)
               throws CalculationException

Description copied from interface: CalculationService

Calculates the given order and all its entries unless they're already calculated and the order has not been modified.

So this method will fetch prices, taxes and discounts (using spring configurable strategies) for uncalculated or modified entries only - all other will remain unchanged. If at least one entry has been calculated or the order itself has been modified the totals will be calculated as well.

if you merely like to adjust totals while keeping prices, taxes and discounts you should call CalculationService.calculateTotals(AbstractOrderModel, boolean) instead (e.g. if just a quantity has changed or prices have been imported and cannot be found via price factory ).

Specified by:

calculate in interface CalculationService

Parameters:

order - target AbstractOrderModel

Throws:

CalculationException - if a pricefactory error occurred.

requiresCalculation

public boolean requiresCalculation(AbstractOrderModel order)

Description copied from interface: CalculationService

Return Boolean.TRUE in case if order needs to be calculated. Default implementation use calculationStrategy to get this information.

Specified by:

requiresCalculation in interface CalculationService

setCalculatedStatus

protected void setCalculatedStatus(AbstractOrderModel order)

setCalculatedStatus

protected void setCalculatedStatus(AbstractOrderEntryModel entry)

calculate

public void calculate(AbstractOrderModel order,
 Date date)
               throws CalculationException

Description copied from interface: CalculationService

Calculates the given order and all its entries unless they're already calculated and the order has not been modified.

So this method will fetch prices, taxes and discounts (using spring configured strategies) for uncalculated or modified entries only - all other will remain unchanged. If at least one entry has been calculated or the order itself has been modified the totals will be calculated as well.

if you merely like to adjust totals while keeping prices, taxes and discounts you should call CalculationService.calculateTotals(AbstractOrderModel, boolean) instead (e.g. if just a quantity has changed or prices have been imported and cannot be found via price factory ).

Specified by:

calculate in interface CalculationService

Parameters:

order - target AbstractOrderModel

date - assumes a given date to perform calculations for - be careful with that since this method will calculate modified or uncalculated entries only, so the given date may not apply to all entries!

Throws:

CalculationException - if a pricefactory error occurred

calculateTotals

public void calculateTotals(AbstractOrderModel order,
 boolean recalculate)
                     throws CalculationException

Description copied from interface: CalculationService

(re)calculates all totals for the given order. This does not trigger price, tax and discount calculation but takes all currently set price, tax and discount values as base.

Specified by:

calculateTotals in interface CalculationService

Parameters:

order - target AbstractOrderModel

recalculate - forces setting total even if order is marked as calculated

Throws:

CalculationException

calculateTotals

protected void calculateTotals(AbstractOrderModel order,
 boolean recalculate,
 Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap)
                        throws CalculationException

calculates all totals. this does not trigger price, tax and discount calculation but takes all currently set price, tax and discount values as base. this method requires the correct subtotal to be set before and the correct tax value map.

Parameters:

recalculate - if false calculation is done only if the calculated flag is not set

taxValueMap - the map { tax value -> Double( sum of all entry totals for this tax ) } obtainable via calculateSubtotal(AbstractOrderModel, boolean)

Throws:

CalculationException

saveOrder

protected void saveOrder(AbstractOrderModel order)

getTaxCorrectionFactor

protected double getTaxCorrectionFactor(Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap,
 double subtotal,
 double total,
 AbstractOrderModel order)
                                 throws CalculationException

Throws:

CalculationException

mustHandleTaxFreeEntries

protected boolean mustHandleTaxFreeEntries(Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap,
 double subtotal,
 AbstractOrderModel order)

getTaxFreeSubTotal

protected double getTaxFreeSubTotal(AbstractOrderModel order)

Calculates the sub total of all order entries with NO tax values.

isAllEntriesTaxed

protected boolean isAllEntriesTaxed(Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap,
 double subtotal,
 AbstractOrderModel order)

recalculate

public void recalculate(AbstractOrderModel order)
                 throws CalculationException

Description copied from interface: CalculationService

recalculates the whole order and all its entries. this includes finding prices, taxes, discounts, payment and delivery costs by calling the currently installed price factory.

if you merely like to adjust totals while keeping prices, taxes and discounts you should call CalculationService.calculateTotals(AbstractOrderModel, boolean) instead (e.g. if just a quantity has changed or prices have been imported and cannot be found via price factory ).

Specified by:

recalculate in interface CalculationService

Parameters:

order - target AbstractOrderModel

Throws:

CalculationException - if a pricefactory error occurred.

recalculate

public void recalculate(AbstractOrderModel order,
 Date date)
                 throws CalculationException

Description copied from interface: CalculationService

recalculates the whole order and all its entries. this includes finding prices, taxes, discounts, payment and delivery costs by calling the currently installed dedicated strategies ( FindPriceStrategy, FindDeliveryCostStrategy, FindTaxValuesStrategy, etc... ).

if you merely like to adjust totals while keeping prices, taxes and discounts you should call CalculationService.calculateTotals(AbstractOrderModel, boolean) instead (e.g. if just a quantity has changed or prices have been imported and cannot be found via price factory ).

Specified by:

recalculate in interface CalculationService

Parameters:

order - target AbstractOrderModel

date - the date to calculate prices for

Throws:

CalculationException - if a pricefactory error occurred

calculateEntries

public void calculateEntries(AbstractOrderModel order,
 boolean forceRecalculate)
                      throws CalculationException

Throws:

CalculationException

calculateTotals

public void calculateTotals(AbstractOrderEntryModel entry,
 boolean recalculate)

Description copied from interface: CalculationService

Recalculates given entries total prices and re-applies tax and discount values. This does not include finding price, taxes or discount but uses all currently set values.

Specified by:

calculateTotals in interface CalculationService

Parameters:

entry - target AbstractOrderEntryModel

recalculate - forces the recalculation of the abstract order entry.

hasJaloStrategies

protected boolean hasJaloStrategies()

calculateTotalTaxValues

protected void calculateTotalTaxValues(AbstractOrderEntryModel entry)

recalculateOrderEntryIfNeeded

protected void recalculateOrderEntryIfNeeded(AbstractOrderEntryModel entry,
 boolean forceRecalculation)
                                      throws CalculationException

Throws:

CalculationException

recalculate

public void recalculate(AbstractOrderEntryModel entry)
                 throws CalculationException

Description copied from interface: CalculationService

Calculates this entry even if the entry was calculated before. This includes finding the correct base price, taxes and discount using the currently installed price factory.

If prices should be left as currently set but the entry totals have to be consolidated (e.g. when the quantity has changed) call CalculationService.calculateTotals(AbstractOrderEntryModel, boolean) instead !

Specified by:

recalculate in interface CalculationService

Parameters:

entry - target AbstractOrderEntryModel

Throws:

CalculationException - if a pricefactory error occurred

refreshOrder

protected void refreshOrder(AbstractOrderModel order)

resetAllValues

protected void resetAllValues(AbstractOrderEntryModel entry)
                       throws CalculationException

Throws:

CalculationException

resetAllValues

protected Map resetAllValues(AbstractOrderModel order)
                      throws CalculationException

Throws:

CalculationException

resetAdditionalCosts

protected void resetAdditionalCosts(AbstractOrderModel order,
 Collection<TaxValue> relativeTaxValues)

convertPriceIfNecessary

public PriceValue convertPriceIfNecessary(PriceValue pv,
 boolean toNet,
 CurrencyModel toCurrency,
 Collection taxValues)

converts a PriceValue object into a double matching the target currency and net/gross - state if necessary. this is the case when the given price value has a different net/gross flag or different currency.

Parameters:

pv - the base price to convert

toNet - the target net/gross state

toCurrency - the target currency

taxValues - the collection of tax values which apply to this price

Returns:

a new PriceValue containing the converted price or pv in case no conversion was necessary

convertDiscountValues

protected List convertDiscountValues(AbstractOrderModel order,
 List dvs)

calculateSubtotal

protected Map<TaxValue,Map<Set<TaxValue>,Double>> calculateSubtotal(AbstractOrderModel order,
 boolean recalculate)

calculateDiscountValues

protected double calculateDiscountValues(AbstractOrderModel order,
 boolean recalculate)

Returns the total discount for this abstract order.

Parameters:

recalculate - true forces a recalculation

Returns:

totalDiscounts

calculateTotalTaxValues

protected double calculateTotalTaxValues(AbstractOrderModel order,
 boolean recalculate,
 int digits,
 double taxAdjustmentFactor,
 Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap)

Parameters:

recalculate -

digits -

taxAdjustmentFactor -

taxValueMap -

Returns:

total taxes

addRelativeEntryTaxValue

protected void addRelativeEntryTaxValue(double entryTotal,
 TaxValue taxValue,
 Set<TaxValue> relativeEntryTaxValues,
 Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap)

addAbsoluteEntryTaxValue

protected void addAbsoluteEntryTaxValue(long entryQuantity,
 TaxValue taxValue,
 Map<TaxValue,Map<Set<TaxValue>,Double>> taxValueMap)

getUnappliedRelativeTaxValues

protected Set<TaxValue> getUnappliedRelativeTaxValues(Collection<TaxValue> allTaxValues)

calculateAbsoluteTotalTaxValue

protected TaxValue calculateAbsoluteTotalTaxValue(CurrencyModel curr,
 String currencyIso,
 int digits,
 boolean net,
 TaxValue taxValue,
 double cumulatedEntryQuantities)

applyGrossMixedRate

protected TaxValue applyGrossMixedRate(TaxValue unappliedTaxValue,
 Map<Set<TaxValue>,Double> taxGroups,
 int digits,
 double taxAdjustmentFactor)

applyNetMixedRate

protected TaxValue applyNetMixedRate(TaxValue unappliedTaxValue,
 Map<Set<TaxValue>,Double> taxGroups,
 int digits,
 double taxAdjustmentFactor)

findTaxValues

protected Collection<TaxValue> findTaxValues(AbstractOrderEntryModel entry)
                                      throws CalculationException

Throws:

CalculationException

findDiscountValues

protected List<DiscountValue> findDiscountValues(AbstractOrderEntryModel entry)
                                          throws CalculationException

Throws:

CalculationException

findGlobalDiscounts

protected List<DiscountValue> findGlobalDiscounts(AbstractOrderModel order)
                                           throws CalculationException

Throws:

CalculationException

findBasePrice

protected PriceValue findBasePrice(AbstractOrderEntryModel entry)
                            throws CalculationException

Throws:

CalculationException

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

setFindTaxesStrategies

public void setFindTaxesStrategies(List<FindTaxValuesStrategy> findTaxesStrategies)

setFindDiscountsStrategies

public void setFindDiscountsStrategies(List<FindDiscountValuesStrategy> findDiscountsStrategies)

setFindPriceStrategy

public void setFindPriceStrategy(FindPriceStrategy findPriceStrategy)

setFindDeliveryCostStrategy

public void setFindDeliveryCostStrategy(FindDeliveryCostStrategy findDeliveryCostStrategy)

setFindPaymentCostStrategy

public void setFindPaymentCostStrategy(FindPaymentCostStrategy findPaymentCostStrategy)

setOrderRequiresCalculationStrategy

public void setOrderRequiresCalculationStrategy(OrderRequiresCalculationStrategy orderRequiresCalculationStrategy)

setTaxFreeEntrySupport

public void setTaxFreeEntrySupport(boolean taxFreeEntrySupport)

getTaxFreeEntrySupport

@Deprecated(since="ages",
            forRemoval=true)
public boolean getTaxFreeEntrySupport()

Deprecated, for removal: This API element is subject to removal in a future version.

since ages - useisTaxFreeEntrySupport()

isTaxFreeEntrySupport

public boolean isTaxFreeEntrySupport()