Package de.hybris.platform.ruleengineservices.rule.evaluation.actions.impl

Class DefaultRAOConsumptionSupport

java.lang.Object

de.hybris.platform.ruleengineservices.rule.evaluation.actions.impl.DefaultRAOConsumptionSupport

All Implemented Interfaces:

RAOConsumptionSupport

public class DefaultRAOConsumptionSupport
extends Object
implements RAOConsumptionSupport

Default implementation of RAOConsumptionSupport

Constructor Summary

Constructors

Constructor	Description
DefaultRAOConsumptionSupport()

Method Summary

Modifier and Type	Method	Description
protected boolean	adjustMultiplierValid(RuleActionContext context, Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs, int adjustMultiplier)
int	adjustStrategyQuantity(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs)	Adjusts the quantity fields of EntriesSelectionStrategyRPD such that the maximum possible number of entries will be consumed by the action.
int	adjustStrategyQuantity(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs, int maxCount)	Adjusts the quantity fields of EntriesSelectionStrategyRPD such that the maximum possible number of entries will be consumed by the action.
int	adjustStrategyQuantity(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs, RuleActionContext context)	Adjusts the quantity fields of EntriesSelectionStrategyRPD such that the maximum possible number of entries will be consumed by the action.
int	adjustStrategyQuantity(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs, RuleActionContext context, int maxCount)	Adjusts the quantity fields of EntriesSelectionStrategyRPD such that the maximum possible number of entries will be consumed by the action.
protected BigDecimal	adjustUnitPrice(OrderEntryRAO orderEntryRao)
protected BigDecimal	adjustUnitPrice(OrderEntryRAO orderEntryRao, int quantity)
<T extends AbstractRuleActionRAO> void	consumeOrderEntries(RuleActionContext context, Collection<EntriesSelectionStrategyRPD> strategies, T actionRAO)	Creates new OrderEntryConusmedRAOs for the given strategies, links them to the given actionRAO and reduces available quantity of order entry by given quantity for every Order Entry from the set and using quantity from discountedOrderEntryMap.
Set<OrderEntryConsumedRAO>	consumeOrderEntries(Set<OrderEntryRAO> selectedEntries, Map<Integer,Integer> selectedEntriesMap, AbstractRuleActionRAO actionRAO)	Creates new OrderEntryConusmedRAOs with the given quantity, links it to the given actionRAO and reduces available quantity of order entry by given quantity for every Order Entry from the set and using quantity from discountedOrderEntryMap.
OrderEntryConsumedRAO	consumeOrderEntry(OrderEntryRAO orderEntryRAO, int quantity, AbstractRuleActionRAO actionRAO)	Creates a new OrderEntryConusmedRAO that consumes the given orderEntryRAO with the given quantity and adds the consumed entry to the given actionRAO
OrderEntryConsumedRAO	consumeOrderEntry(OrderEntryRAO orderEntryRAO, int quantity, BigDecimal discountValue, AbstractRuleActionRAO actionRAO)	Creates a new OrderEntryConusmedRAO that consumes the given orderEntryRAO and adds the consumed entry to the given actionRAO
OrderEntryConsumedRAO	consumeOrderEntry(OrderEntryRAO orderEntryRAO, AbstractRuleActionRAO actionRAO)	Creates a new OrderEntryConusmedRAO that consumes the given orderEntryRAO and adds the consumed entry to the given actionRAO
OrderEntryConsumedRAO	createOrderEntryConsumedRAO(OrderEntryRAO orderEntryRAO, int quantity, BigDecimal discountValue)	Creates new OrderEntryConsumedRAO for given OrderEntryRAO and with given quantity.
protected int	getAdjustMultiplierForStrategyRPD(EntriesSelectionStrategyRPD strategyRPD)
int	getConsumableQuantity(OrderEntryRAO orderEntryRao)	Calculate the order entry consumable quantity
Set<OrderEntryConsumedRAO>	getConsumedOrderEntryInfoForOrderEntry(OrderEntryRAO orderEntryRao)	Calculate the order entry discount infos
protected Set<OrderEntryConsumedRAO>	getConsumedOrderEntryInfoForOrderEntry(OrderEntryRAO orderEntryRAO, Set<AbstractRuleActionRAO> actions)
int	getConsumedQuantityForOrderEntry(OrderEntryRAO orderEntryRao)	Return consumed quantity for a given order entry
protected int	getConsumedQuantityForOrderEntry(OrderEntryRAO orderEntryRao, Set<AbstractRuleActionRAO> actions)
protected CurrencyUtils	getCurrencyUtils()
Map<Integer,Integer>	getEligibleEntryQuantities(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs)
protected Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy>	getEntriesSelectionStrategies()
protected PriceAdjustmentStrategy<OrderEntryRAO>	getPriceAdjustmentStrategy()
protected Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy>	getQualifyingEntriesSelectionStrategies()
protected RAOLookupService	getRaoLookupService()
Map<Integer,Integer>	getSelectedOrderEntryQuantities(RuleActionContext context, Collection<EntriesSelectionStrategyRPD> strategies)	Gets Order Entry identifiers (orderEntry.entryNumber) and Unit Quantity To Be Consumed for the Order Entries.
Set<OrderEntryRAO>	getSelectedOrderEntryRaos(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs, Map<Integer,Integer> selectedOrderEntryMap)	Gets Order Entry set to be discounted as a result of bundle processing.
protected SwitchService	getSwitchService()
boolean	hasEnoughQuantity(RuleActionContext context, Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs)	Checks if all entriesSelectionStrategyRPDs have enough quantity.
protected boolean	hasEnoughQuantity(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs)
boolean	isConsumptionEnabled()	Identifies whether order entry consumption is enabled
void	mergeOrderEntryConsumed(OrderEntryConsumedRAO consumedTarget, OrderEntryConsumedRAO consumedSource)	Method merges the properties of two instances of OrderEntryConsumedRAO if the objects refer to the same order entry number and same rule
protected void	putEligibleEntryQuantities(Map<Integer,Integer> entriesToBeConsumedMap, EntriesSelectionStrategyRPD strategy)	Deprecated, for removal: This API element is subject to removal in a future version. since 2205, Please use putEligibleEntryQuantities(entryQuantities, entriesToBeConsumedMap, strategy)
protected void	putEligibleEntryQuantities(Map<Integer,Integer> entryQuantities, Map<Integer,Integer> entriesToBeConsumedMap, EntriesSelectionStrategyRPD strategy)
protected EntriesSelectionStrategyRPD	saveSourceRPDWithAdjustMultiplierAsNew(EntriesSelectionStrategyRPD source, int adjustMultiplier)
void	setCurrencyUtils(CurrencyUtils currencyUtils)
void	setEntriesSelectionStrategies(Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy> entriesSelectionStrategies)
void	setPriceAdjustmentStrategy(PriceAdjustmentStrategy<OrderEntryRAO> priceAdjustmentStrategy)
void	setQualifyingEntriesSelectionStrategies(Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy> qualifyingEntriesSelectionStrategies)
void	setRaoLookupService(RAOLookupService raoLookupService)
void	setSwitchService(SwitchService switchService)
void	trackConsumedProducts(RuleActionContext context)
void	updateActionRAOWithConsumed(AbstractRuleActionRAO actionRAO, OrderEntryConsumedRAO orderEntryConsumedRAO)	Adds given OrderEntryConsumedRAO to the AbstractRuleActionRAO.consumedEntries.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultRAOConsumptionSupport

public DefaultRAOConsumptionSupport()

Method Details

isConsumptionEnabled

public boolean isConsumptionEnabled()

Description copied from interface: RAOConsumptionSupport

Identifies whether order entry consumption is enabled

Specified by:

isConsumptionEnabled in interface RAOConsumptionSupport

Returns:

true in case consumption is enabled, false otherwise

trackConsumedProducts

public void trackConsumedProducts(RuleActionContext context)

Specified by:

trackConsumedProducts in interface RAOConsumptionSupport

Parameters:

context - instance of RuleActionContext

consumeOrderEntry

public OrderEntryConsumedRAO consumeOrderEntry(OrderEntryRAO orderEntryRAO,
 int quantity,
 BigDecimal discountValue,
 AbstractRuleActionRAO actionRAO)

Description copied from interface: RAOConsumptionSupport

Creates a new OrderEntryConusmedRAO that consumes the given orderEntryRAO and adds the consumed entry to the given actionRAO

Specified by:

consumeOrderEntry in interface RAOConsumptionSupport

Parameters:

orderEntryRAO - the order entry to consume

quantity - the quantity to consume

discountValue - the discount this order entry consumption gave

actionRAO - the action rao to add the consumed entry to

Returns:

the newly created consumed entry

consumeOrderEntry

public OrderEntryConsumedRAO consumeOrderEntry(OrderEntryRAO orderEntryRAO,
 AbstractRuleActionRAO actionRAO)

Description copied from interface: RAOConsumptionSupport

Creates a new OrderEntryConusmedRAO that consumes the given orderEntryRAO and adds the consumed entry to the given actionRAO

Specified by:

consumeOrderEntry in interface RAOConsumptionSupport

Parameters:

orderEntryRAO - the order entry to consume

actionRAO - the action rao to add the consumed entry to

Returns:

the newly created consumed entry

consumeOrderEntry

public OrderEntryConsumedRAO consumeOrderEntry(OrderEntryRAO orderEntryRAO,
 int quantity,
 AbstractRuleActionRAO actionRAO)

Description copied from interface: RAOConsumptionSupport

Creates a new OrderEntryConusmedRAO that consumes the given orderEntryRAO with the given quantity and adds the consumed entry to the given actionRAO

Specified by:

consumeOrderEntry in interface RAOConsumptionSupport

Parameters:

orderEntryRAO - the order entry to consume

quantity - the quantity to consume

actionRAO - the action rao to add the consumed entry to

Returns:

the newly created consumed entry

consumeOrderEntries

public <T extends AbstractRuleActionRAO> void consumeOrderEntries(RuleActionContext context,
 Collection<EntriesSelectionStrategyRPD> strategies,
 T actionRAO)

Description copied from interface: RAOConsumptionSupport

Creates new OrderEntryConusmedRAOs for the given strategies, links them to the given actionRAO and reduces available quantity of order entry by given quantity for every Order Entry from the set and using quantity from discountedOrderEntryMap.

Specified by:

consumeOrderEntries in interface RAOConsumptionSupport

Parameters:

context - instance of RuleActionContext

strategies - the selection strategies

actionRAO - the AbstractRuleActionRAO to add the newly created consumed entries to

consumeOrderEntries

public Set<OrderEntryConsumedRAO> consumeOrderEntries(Set<OrderEntryRAO> selectedEntries,
 Map<Integer,Integer> selectedEntriesMap,
 AbstractRuleActionRAO actionRAO)

Description copied from interface: RAOConsumptionSupport

Creates new OrderEntryConusmedRAOs with the given quantity, links it to the given actionRAO and reduces available quantity of order entry by given quantity for every Order Entry from the set and using quantity from discountedOrderEntryMap.

Specified by:

consumeOrderEntries in interface RAOConsumptionSupport

Parameters:

selectedEntries - Order Entries to be consumed

selectedEntriesMap - Map having orderEntry.entryNumber as keys and Unit Quantity To Be Consumed as values

actionRAO - the AbstractRuleActionRAO to add the newly created consumed entries to

getConsumedQuantityForOrderEntry

public int getConsumedQuantityForOrderEntry(OrderEntryRAO orderEntryRao)

Description copied from interface: RAOConsumptionSupport

Return consumed quantity for a given order entry

Specified by:

getConsumedQuantityForOrderEntry in interface RAOConsumptionSupport

Parameters:

orderEntryRao - Cart order entry

Returns:

consumed quantity

getSelectedOrderEntryQuantities

public Map<Integer,Integer> getSelectedOrderEntryQuantities(RuleActionContext context,
 Collection<EntriesSelectionStrategyRPD> strategies)

Description copied from interface: RAOConsumptionSupport

Gets Order Entry identifiers (orderEntry.entryNumber) and Unit Quantity To Be Consumed for the Order Entries.

Specified by:

getSelectedOrderEntryQuantities in interface RAOConsumptionSupport

strategies - list of EntriesSelectionStrategyRPD to pickup units according to the strategies

Returns:

Map having orderEntry.entryNumber as keys and Unit Quantity To Be Consumed as values

getSelectedOrderEntryRaos

public Set<OrderEntryRAO> getSelectedOrderEntryRaos(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs,
 Map<Integer,Integer> selectedOrderEntryMap)

Description copied from interface: RAOConsumptionSupport

Gets Order Entry set to be discounted as a result of bundle processing.

Specified by:

getSelectedOrderEntryRaos in interface RAOConsumptionSupport

Parameters:

selectionStrategyRPDs - list of EntriesSelectionStrategyRPD to pickup units according to the strategies

selectedOrderEntryMap - Map having orderEntry.entryNumber as keys and Unit Quantity To Be Consumed as values

createOrderEntryConsumedRAO

public OrderEntryConsumedRAO createOrderEntryConsumedRAO(OrderEntryRAO orderEntryRAO,
 int quantity,
 BigDecimal discountValue)

Description copied from interface: RAOConsumptionSupport

Creates new OrderEntryConsumedRAO for given OrderEntryRAO and with given quantity.

Specified by:

createOrderEntryConsumedRAO in interface RAOConsumptionSupport

Parameters:

orderEntryRAO - OrderEntryRAO to create consumed entry for

quantity - Consumed quantity

discountValue - the discount this order entry consumption gave

Returns:

created OrderEntryConsumedRAO

updateActionRAOWithConsumed

public void updateActionRAOWithConsumed(AbstractRuleActionRAO actionRAO,
 OrderEntryConsumedRAO orderEntryConsumedRAO)

Description copied from interface: RAOConsumptionSupport

Adds given OrderEntryConsumedRAO to the AbstractRuleActionRAO.consumedEntries.

Specified by:

updateActionRAOWithConsumed in interface RAOConsumptionSupport

Parameters:

actionRAO - AbstractRuleActionRAO to be updated

orderEntryConsumedRAO - to be added to the AbstractRuleActionRAO

mergeOrderEntryConsumed

public void mergeOrderEntryConsumed(OrderEntryConsumedRAO consumedTarget,
 OrderEntryConsumedRAO consumedSource)

Description copied from interface: RAOConsumptionSupport

Method merges the properties of two instances of OrderEntryConsumedRAO if the objects refer to the same order entry number and same rule

Specified by:

mergeOrderEntryConsumed in interface RAOConsumptionSupport

Parameters:

consumedTarget - where to merge the data to

consumedSource - where to merge the data from

hasEnoughQuantity

public boolean hasEnoughQuantity(RuleActionContext context,
 Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs)

Description copied from interface: RAOConsumptionSupport

Checks if all entriesSelectionStrategyRPDs have enough quantity.

Specified by:

hasEnoughQuantity in interface RAOConsumptionSupport

selectionStrategyRPDs - List of EntriesSelectionStrategyRPD to check

Returns:

true if all entries selection strategies have enough quantity. false if at least one doesn't have.

hasEnoughQuantity

protected boolean hasEnoughQuantity(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs)

getEligibleEntryQuantities

public Map<Integer,Integer> getEligibleEntryQuantities(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs)

Specified by:

getEligibleEntryQuantities in interface RAOConsumptionSupport

adjustStrategyQuantity

public int adjustStrategyQuantity(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs)

Description copied from interface: RAOConsumptionSupport

Adjusts the quantity fields of EntriesSelectionStrategyRPD such that the maximum possible number of entries will be consumed by the action. This is done by finding the highest integer multiple that the strategy.quantity can be multiplied by that there is sufficient quantity in the associated OrderEntryRAO object. This figure is then multiplied by the original quantity of the selection strategy.

Specified by:

adjustStrategyQuantity in interface RAOConsumptionSupport

Parameters:

selectionStrategyRPDs - list of EntriesSelectionStrategyRPD to be updated

Returns:

The multiple count used to scale the quantity fields of the strategy objects

adjustStrategyQuantity

public int adjustStrategyQuantity(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs,
 int maxCount)

Description copied from interface: RAOConsumptionSupport

Adjusts the quantity fields of EntriesSelectionStrategyRPD such that the maximum possible number of entries will be consumed by the action. This is done by finding the highest integer multiple that the strategy.quantity can be multiplied by that there is sufficient quantity in the associated OrderEntryRAO object. This figure is then multiplied by the original quantity of the selection strategy.

Specified by:

adjustStrategyQuantity in interface RAOConsumptionSupport

Parameters:

selectionStrategyRPDs - list of EntriesSelectionStrategyRPD to be updated

maxCount - when maxCount is greater than 0, this parameter acts as an absolute maximum for the multiple.

Returns:

The multiple count used to scale the quantity fields of the strategy objects

adjustStrategyQuantity

public int adjustStrategyQuantity(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs,
 RuleActionContext context)

Description copied from interface: RAOConsumptionSupport

Adjusts the quantity fields of EntriesSelectionStrategyRPD such that the maximum possible number of entries will be consumed by the action. This is done by finding the highest integer multiple that the strategy.quantity can be multiplied by that there is sufficient quantity in the associated OrderEntryRAO object. This figure is then multiplied by the original quantity of the selection strategy.

Specified by:

adjustStrategyQuantity in interface RAOConsumptionSupport

Parameters:

selectionStrategyRPDs - list of EntriesSelectionStrategyRPD to be updated

context - instance of RuleActionContext

Returns:

The multiple count used to scale the quantity fields of the strategy objects

adjustStrategyQuantity

public int adjustStrategyQuantity(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs,
 RuleActionContext context,
 int maxCount)

Description copied from interface: RAOConsumptionSupport

Adjusts the quantity fields of EntriesSelectionStrategyRPD such that the maximum possible number of entries will be consumed by the action. This is done by finding the highest integer multiple that the strategy.quantity can be multiplied by that there is sufficient quantity in the associated OrderEntryRAO object. This figure is then multiplied by the original quantity of the selection strategy.

Specified by:

adjustStrategyQuantity in interface RAOConsumptionSupport

Parameters:

selectionStrategyRPDs - list of EntriesSelectionStrategyRPD to be updated

context - instance of RuleActionContext

maxCount - when maxCount is greater than 0, this parameter acts as an absolute maximum for the multiple.

Returns:

The multiple count used to scale the quantity fields of the strategy objects

getAdjustMultiplierForStrategyRPD

protected int getAdjustMultiplierForStrategyRPD(EntriesSelectionStrategyRPD strategyRPD)

adjustMultiplierValid

protected boolean adjustMultiplierValid(RuleActionContext context,
 Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs,
 int adjustMultiplier)

saveSourceRPDWithAdjustMultiplierAsNew

protected EntriesSelectionStrategyRPD saveSourceRPDWithAdjustMultiplierAsNew(EntriesSelectionStrategyRPD source,
 int adjustMultiplier)

getConsumableQuantity

public int getConsumableQuantity(OrderEntryRAO orderEntryRao)

Description copied from interface: RAOConsumptionSupport

Calculate the order entry consumable quantity

Specified by:

getConsumableQuantity in interface RAOConsumptionSupport

Parameters:

orderEntryRao - instance of OrderEntryRAO

Returns:

number of units available for consumption

getConsumedOrderEntryInfoForOrderEntry

public Set<OrderEntryConsumedRAO> getConsumedOrderEntryInfoForOrderEntry(OrderEntryRAO orderEntryRao)

Description copied from interface: RAOConsumptionSupport

Calculate the order entry discount infos

Specified by:

getConsumedOrderEntryInfoForOrderEntry in interface RAOConsumptionSupport

Parameters:

orderEntryRao - instance of OrderEntryRAO

Returns:

The order entry discount infos

getConsumedOrderEntryInfoForOrderEntry

protected Set<OrderEntryConsumedRAO> getConsumedOrderEntryInfoForOrderEntry(OrderEntryRAO orderEntryRAO,
 Set<AbstractRuleActionRAO> actions)

putEligibleEntryQuantities

@Deprecated(since="2205",
            forRemoval=true)
protected void putEligibleEntryQuantities(Map<Integer,Integer> entriesToBeConsumedMap,
 EntriesSelectionStrategyRPD strategy)

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

since 2205, Please use putEligibleEntryQuantities(entryQuantities, entriesToBeConsumedMap, strategy)

Parameters:

entriesToBeConsumedMap - entries need to consume, merge the result into this map

strategy - StrategyRPD for a container

putEligibleEntryQuantities

protected void putEligibleEntryQuantities(Map<Integer,Integer> entryQuantities,
 Map<Integer,Integer> entriesToBeConsumedMap,
 EntriesSelectionStrategyRPD strategy)

adjustUnitPrice

protected BigDecimal adjustUnitPrice(OrderEntryRAO orderEntryRao)

adjustUnitPrice

protected BigDecimal adjustUnitPrice(OrderEntryRAO orderEntryRao,
 int quantity)

getConsumedQuantityForOrderEntry

protected int getConsumedQuantityForOrderEntry(OrderEntryRAO orderEntryRao,
 Set<AbstractRuleActionRAO> actions)

getRaoLookupService

protected RAOLookupService getRaoLookupService()

setRaoLookupService

public void setRaoLookupService(RAOLookupService raoLookupService)

getEntriesSelectionStrategies

protected Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy> getEntriesSelectionStrategies()

setEntriesSelectionStrategies

public void setEntriesSelectionStrategies(Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy> entriesSelectionStrategies)

getQualifyingEntriesSelectionStrategies

protected Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy> getQualifyingEntriesSelectionStrategies()

setQualifyingEntriesSelectionStrategies

public void setQualifyingEntriesSelectionStrategies(Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy> qualifyingEntriesSelectionStrategies)

getCurrencyUtils

protected CurrencyUtils getCurrencyUtils()

setCurrencyUtils

public void setCurrencyUtils(CurrencyUtils currencyUtils)

getSwitchService

protected SwitchService getSwitchService()

setSwitchService

public void setSwitchService(SwitchService switchService)

getPriceAdjustmentStrategy

protected PriceAdjustmentStrategy<OrderEntryRAO> getPriceAdjustmentStrategy()

setPriceAdjustmentStrategy

public void setPriceAdjustmentStrategy(PriceAdjustmentStrategy<OrderEntryRAO> priceAdjustmentStrategy)