com.broadleafcommerce.oms.refund.strategy

Class AppeasementStrategyImpl

java.lang.Object

com.broadleafcommerce.oms.refund.strategy.AppeasementStrategyImpl

All Implemented Interfaces:

AppeasementStrategy

@Service(value="blAppeasementStrategy")
public class AppeasementStrategyImpl
extends Object
implements AppeasementStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected AppeasementAdjustmentDao	appeasementAdjustmentDao
protected AppeasementFulfillmentAdjustmentDao	appeasementFulfillmentAdjustmentDao
protected static org.apache.commons.logging.Log	LOG

Constructor Summary

Constructors

Constructor and Description
AppeasementStrategyImpl()

Method Summary

Modifier and Type	Method and Description
long	applyDifferenceToProratedAppeasement(FulfillmentOrderItem foi, long numApplicationsNeeded, org.broadleafcommerce.common.money.Money unitAmount)
protected org.broadleafcommerce.common.money.Money	calculateFulfillmentAmount(FulfillmentOrder fulfillmentOrder)
org.broadleafcommerce.common.money.Money	calculateFulfillmentAmountSum(List<FulfillmentOrder> fulfillmentOrders)
protected org.broadleafcommerce.common.money.Money	calculateItemAmount(FulfillmentOrderItem foi)
org.broadleafcommerce.common.money.Money	calculateItemAmountSum(List<FulfillmentOrderItem> fois)
protected long	countNumberOfUnits(org.broadleafcommerce.common.money.Money difference)
void	distributeAppeasementAcrossItems(String reason, List<FulfillmentOrderItem> fois, org.broadleafcommerce.common.money.Money totalAppeasement)
void	distributeAppeasementPercentageAcrossItems(String reason, List<FulfillmentOrderItem> fois, BigDecimal percentage)
protected org.broadleafcommerce.common.money.Money	distributeAppeasementToFulfillmentOrders(String reason, List<FulfillmentOrder> fulfillmentOrders, BigDecimal totalAppeasement, BigDecimal totalFulfillment) Distributes the fulfillment appeasement to the individual fulfillment orders via AppeasementFulfillmentAdjustments By default, pro-rates total fulfillment appeasement across the fulfillment orders based on relative amount
protected org.broadleafcommerce.common.money.Money	distributeAppeasementToItems(String reason, List<FulfillmentOrderItem> fois, BigDecimal totalAppeasement, BigDecimal totalAllItems) Distributes the order appeasement to the individual fulfillment order items via AppeasementAdjustments By default, pro-rates total appeasement across the items based on relative amount
void	distributeAppeasementWithFulfillmentOverrides(String reason, Map<org.broadleafcommerce.core.order.domain.FulfillmentGroup,org.broadleafcommerce.common.money.Money> fulfillmentOverrideMap)
void	distributeAppeasementWithPriceOverrideItems(String reason, Map<FulfillmentOrderItem,org.broadleafcommerce.common.money.Money> priceOverrideMap)
void	distributeFulfillmentAppeasement(String reason, List<FulfillmentOrder> fulfillmentOrders, org.broadleafcommerce.common.money.Money totalFulfillmentAppeasement)
protected void	fixAppeasementAdjustmentRoundingIssues(List<FulfillmentOrderItem> fois, org.broadleafcommerce.common.money.Money totalAppeasement, org.broadleafcommerce.common.money.Money totalAppeasementAdjustmentDistributed) It is possible due to rounding that the appeasement adjustments do not match the total appeasement.
protected void	fixFulfillmentAppeasementRoundingIssues(List<FulfillmentOrder> fulfillmentOrders, org.broadleafcommerce.common.money.Money totalAppeasement, org.broadleafcommerce.common.money.Money totalAppeasementAdjustmentDistributed) It is possible due to rounding that the appeasement fulfillment adjustments do not match the total fulfillment appeasement.
org.broadleafcommerce.common.money.Money	getUnitAmount(org.broadleafcommerce.common.money.Money difference) Returns the unit amount (e.g.
List<FulfillmentOrderItem>	getValidAppeasementItems(FulfillmentOrder fulfillmentOrder) Returns valid appeasement items for a fulfillment order.
List<FulfillmentOrderItem>	getValidAppeasementItems(OMSOrder order) Returns valid appeasement items for an order.
List<FulfillmentOrder>	getValidAppeasementOrders(OMSFulfillmentGroup fulfillmentGroup)
List<FulfillmentOrder>	getValidAppeasementOrders(OMSOrder order)
protected boolean	isFulfillmentOrderItemReturned(FulfillmentOrderItem fulfillmentOrderItem)
protected void	validateFulfillmentOrderItems(List<FulfillmentOrderItem> fois) Validates that the fulfillment order items passed in are applicable for an adjustment.
protected void	validateFulfillmentOrders(List<FulfillmentOrder> fulfillmentOrders) Validates that the fulfillment orders passed in are applicable for an adjustment.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.commons.logging.Log LOG

appeasementAdjustmentDao

protected AppeasementAdjustmentDao appeasementAdjustmentDao

appeasementFulfillmentAdjustmentDao

protected AppeasementFulfillmentAdjustmentDao appeasementFulfillmentAdjustmentDao

Constructor Detail

AppeasementStrategyImpl

public AppeasementStrategyImpl()

Method Detail

getValidAppeasementOrders

public List<FulfillmentOrder> getValidAppeasementOrders(OMSOrder order)

Specified by:

getValidAppeasementOrders in interface AppeasementStrategy

getValidAppeasementOrders

public List<FulfillmentOrder> getValidAppeasementOrders(OMSFulfillmentGroup fulfillmentGroup)

Specified by:

getValidAppeasementOrders in interface AppeasementStrategy

getValidAppeasementItems

public List<FulfillmentOrderItem> getValidAppeasementItems(FulfillmentOrder fulfillmentOrder)

Returns valid appeasement items for a fulfillment order. i.e. items that have not already been returned or partially returned.

Specified by:

getValidAppeasementItems in interface AppeasementStrategy

Parameters:

fulfillmentOrder -

Returns:

getValidAppeasementItems

public List<FulfillmentOrderItem> getValidAppeasementItems(OMSOrder order)

Returns valid appeasement items for an order. i.e. items that have not already been returned or partially returned.

Specified by:

getValidAppeasementItems in interface AppeasementStrategy

Parameters:

order -

Returns:

isFulfillmentOrderItemReturned

protected boolean isFulfillmentOrderItemReturned(FulfillmentOrderItem fulfillmentOrderItem)

distributeAppeasementWithFulfillmentOverrides

public void distributeAppeasementWithFulfillmentOverrides(String reason,
                                                          Map<org.broadleafcommerce.core.order.domain.FulfillmentGroup,org.broadleafcommerce.common.money.Money> fulfillmentOverrideMap)

Specified by:

distributeAppeasementWithFulfillmentOverrides in interface AppeasementStrategy

distributeFulfillmentAppeasement

public void distributeFulfillmentAppeasement(String reason,
                                             List<FulfillmentOrder> fulfillmentOrders,
                                             org.broadleafcommerce.common.money.Money totalFulfillmentAppeasement)

Specified by:

distributeFulfillmentAppeasement in interface AppeasementStrategy

distributeAppeasementPercentageAcrossItems

public void distributeAppeasementPercentageAcrossItems(String reason,
                                                       List<FulfillmentOrderItem> fois,
                                                       BigDecimal percentage)

Specified by:

distributeAppeasementPercentageAcrossItems in interface AppeasementStrategy

distributeAppeasementAcrossItems

public void distributeAppeasementAcrossItems(String reason,
                                             List<FulfillmentOrderItem> fois,
                                             org.broadleafcommerce.common.money.Money totalAppeasement)

Specified by:

distributeAppeasementAcrossItems in interface AppeasementStrategy

distributeAppeasementWithPriceOverrideItems

public void distributeAppeasementWithPriceOverrideItems(String reason,
                                                        Map<FulfillmentOrderItem,org.broadleafcommerce.common.money.Money> priceOverrideMap)

Specified by:

distributeAppeasementWithPriceOverrideItems in interface AppeasementStrategy

validateFulfillmentOrders

protected void validateFulfillmentOrders(List<FulfillmentOrder> fulfillmentOrders)

Validates that the fulfillment orders passed in are applicable for an adjustment. That is, they are all part of the same order and are valid appeasement orders.

Parameters:

fois -

validateFulfillmentOrderItems

protected void validateFulfillmentOrderItems(List<FulfillmentOrderItem> fois)

Validates that the fulfillment order items passed in are applicable for an adjustment. That is, they are all part of the same order and the items are valid appeasement items.

Parameters:

fois -

calculateFulfillmentAmountSum

public org.broadleafcommerce.common.money.Money calculateFulfillmentAmountSum(List<FulfillmentOrder> fulfillmentOrders)

Specified by:

calculateFulfillmentAmountSum in interface AppeasementStrategy

calculateFulfillmentAmount

protected org.broadleafcommerce.common.money.Money calculateFulfillmentAmount(FulfillmentOrder fulfillmentOrder)

calculateItemAmountSum

public org.broadleafcommerce.common.money.Money calculateItemAmountSum(List<FulfillmentOrderItem> fois)

Specified by:

calculateItemAmountSum in interface AppeasementStrategy

calculateItemAmount

protected org.broadleafcommerce.common.money.Money calculateItemAmount(FulfillmentOrderItem foi)

distributeAppeasementToFulfillmentOrders

protected org.broadleafcommerce.common.money.Money distributeAppeasementToFulfillmentOrders(String reason,
                                                                                            List<FulfillmentOrder> fulfillmentOrders,
                                                                                            BigDecimal totalAppeasement,
                                                                                            BigDecimal totalFulfillment)

Distributes the fulfillment appeasement to the individual fulfillment orders via AppeasementFulfillmentAdjustments By default, pro-rates total fulfillment appeasement across the fulfillment orders based on relative amount

Parameters:

reason -

fulfillmentOrders -

totalAppeasement -

totalFulfillment -

Returns:

distributeAppeasementToItems

protected org.broadleafcommerce.common.money.Money distributeAppeasementToItems(String reason,
                                                                                List<FulfillmentOrderItem> fois,
                                                                                BigDecimal totalAppeasement,
                                                                                BigDecimal totalAllItems)

Distributes the order appeasement to the individual fulfillment order items via AppeasementAdjustments By default, pro-rates total appeasement across the items based on relative amount

Parameters:

reason -

fois -

totalAppeasement -

totalAllItems -

Returns:

fixFulfillmentAppeasementRoundingIssues

protected void fixFulfillmentAppeasementRoundingIssues(List<FulfillmentOrder> fulfillmentOrders,
                                                       org.broadleafcommerce.common.money.Money totalAppeasement,
                                                       org.broadleafcommerce.common.money.Money totalAppeasementAdjustmentDistributed)

It is possible due to rounding that the appeasement fulfillment adjustments do not match the total fulfillment appeasement. This method fixes by adding or removing the units (pennies etc...)

Parameters:

fulfillmentOrders -

totalAppeasement -

totalAppeasementAdjustmentDistributed -

fixAppeasementAdjustmentRoundingIssues

protected void fixAppeasementAdjustmentRoundingIssues(List<FulfillmentOrderItem> fois,
                                                      org.broadleafcommerce.common.money.Money totalAppeasement,
                                                      org.broadleafcommerce.common.money.Money totalAppeasementAdjustmentDistributed)

It is possible due to rounding that the appeasement adjustments do not match the total appeasement. This method fixes by adding or removing the units (pennies etc...)

Parameters:

fois -

totalAppeasement -

totalAppeasementAdjustmentDistributed -

countNumberOfUnits

protected long countNumberOfUnits(org.broadleafcommerce.common.money.Money difference)

getUnitAmount

public org.broadleafcommerce.common.money.Money getUnitAmount(org.broadleafcommerce.common.money.Money difference)

Returns the unit amount (e.g. .01 for US)

Parameters:

difference -

Returns:

applyDifferenceToProratedAppeasement

public long applyDifferenceToProratedAppeasement(FulfillmentOrderItem foi,
                                                 long numApplicationsNeeded,
                                                 org.broadleafcommerce.common.money.Money unitAmount)