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

Class AbstractRuleExecutableSupport

java.lang.Object

de.hybris.platform.ruleengineservices.rule.evaluation.actions.AbstractRuleExecutableSupport

Direct Known Subclasses:

AbstractRulePartnerProductAction, ProductConfigAbstractRAOAction, RuleAddCouponRAOAction, RuleAddFreeProductDiscountRAOAction, RuleAddProductPercentageDiscountRAOAction, RuleChangeDeliveryModeRAOAction, RuleFreeGiftRAOAction, RuleFreeGiftToBundleRAOAction, RuleOrderEntryFixedDiscountRAOAction, RuleOrderEntryFixedPriceRAOAction, RuleOrderEntryGroupFixedDiscountRAOAction, RuleOrderEntryPercentageDiscountRAOAction, RuleOrderFixedDiscountRAOAction, RuleOrderPercentageDiscountExcludedProductsRAOAction, RuleOrderPercentageDiscountRAOAction, RuleTriggerMessageRAOAction

public class AbstractRuleExecutableSupport
extends Object

Constructor Summary

Constructors

Constructor and Description
AbstractRuleExecutableSupport()

Method Summary

Modifier and Type	Method and Description
protected void	addMetadataToRao(AbstractRuleActionRAO rao, RuleActionContext context)
protected 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.
protected BigDecimal	adjustUnitPrice(OrderEntryRAO orderEntryRao)
protected BigDecimal	adjustUnitPrice(OrderEntryRAO orderEntryRao, int quantity)
protected KnowledgeHelper	checkAndGetRuleContext(RuleActionContext context) Checks that the given ruleContext is of type KnowledgeHelper (i.e.
protected <T> T	checkArgumentAndGet(String name, Class<T> type, Map<String,Object> properties)
protected Set<OrderEntryConsumedRAO>	consumeOrderEntries(Collection<EntriesSelectionStrategyRPD> strategies, AbstractRuleActionRAO 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.
protected 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.
protected OrderEntryConsumedRAO	consumeOrderEntry(OrderEntryRAO orderEntryRAO, AbstractRuleActionRAO actionRAO) Creates a new OrderEntryConusmedRAO that consumes the given orderEntryRAO and adds the consumed entry to the given actionRAO
protected OrderEntryConsumedRAO	consumeOrderEntry(OrderEntryRAO orderEntryRAO, int quantity, BigDecimal discountValue, AbstractRuleActionRAO actionRAO)
protected OrderEntryConsumedRAO	createOrderEntryConsumedRAO(OrderEntryRAO orderEntryRAO, int quantity, BigDecimal discountValue) Creates new OrderEntryConsumedRAO for given OrderEntryRAO and with given quantity.
protected Optional<BigDecimal>	extractAmountForCurrency(RuleActionContext context, Object currencyAmount)
protected <T> Optional<T>	extractFact(RuleActionContext context, Predicate<Object> objectFilter)
protected List<ActionSupplementStrategy>	getActionSupplementStrategies()
String	getBeanName()
protected ConfigurationService	getConfigurationService()
protected Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy>	getEntriesSelectionStrategies()
protected Map<String,String>	getMetaDataFromRule(RuleActionContext context)
protected String	getMetaDataFromRule(RuleActionContext context, String key) Returns the rule's meta-data for the given key (or null).
protected OrderUtils	getOrderUtils()
protected RaoUtils	getRaoUtils()
protected String	getRuleCode(RuleActionContext context) Returns the rule's rule code meta data.
protected RuleConfigurationRRD	getRuleConfigurationRRD(String ruleCode, RuleActionContext context) retrieves the RuleConfigurationRRD for the given ruleCode from the given context.
protected RuleCurrencyConverterStrategy	getRuleCurrencyConverterStrategy()
protected RuleEngineCalculationService	getRuleEngineCalculationService()
protected RuleGroupExecutionRRD	getRuleGroupExecutionRRD(String ruleGroupCode, RuleActionContext context) retrieves the RuleGroupExecutionRRD for the given ruleGroupCode from the given context.
protected Map<Integer,Integer>	getSelectedOrderEntryQuantities(Collection<EntriesSelectionStrategyRPD> strategies) Gets Order Entry identifiers (orderEntry.entryNumber) and Unit Quantity To Be Consumed for the Order Entries.
protected Set<OrderEntryRAO>	getSelectedOrderEntryRaos(Collection<EntriesSelectionStrategyRPD> selectionStrategyRPDs, Map<Integer,Integer> selectedOrderEntryMap) Gets Order Entry set to be discounted as a result of bundle processing.
protected boolean	hasEnoughQuantity(EntriesSelectionStrategyRPD entriesSelectionStrategyRPD) Checks in total quantity of all entries in the selection strategy is enough for the quantity to consume.
protected boolean	hasEnoughQuantity(List<EntriesSelectionStrategyRPD> entriesSelectionStrategyRPDs) Checks if all entriesSelectionStrategyRPDs have enough quantity.
protected boolean	mergeDiscounts(RuleActionContext context, DiscountRAO discountRao, OrderEntryRAO entry)
protected void	postProcessAction(AbstractRuleActionRAO actionRao, RuleActionContext context, Map<String,Object> parameters)
void	setActionSupplementStrategies(List<ActionSupplementStrategy> actionSupplementStrategies)
void	setBeanName(String beanName)
void	setConfigurationService(ConfigurationService configurationService)
void	setEntriesSelectionStrategies(Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy> entriesSelectionStrategies)
void	setOrderUtils(OrderUtils orderUtils)
void	setRAOMetaData(RuleActionContext context, AbstractRuleActionRAO... raos)
void	setRaoUtils(RaoUtils raoUtils)
void	setRuleCurrencyConverterStrategy(RuleCurrencyConverterStrategy ruleCurrencyConverterStrategy)
void	setRuleEngineCalculationService(RuleEngineCalculationService ruleEngineCalculationService)
protected void	splitEntriesSelectionStrategies(List<EntriesSelectionStrategyRPD> entriesSelectionStrategyRPDs, List<EntriesSelectionStrategyRPD> selectionStrategyRPDsForAction, List<EntriesSelectionStrategyRPD> selectionStrategyRPDsForTriggering)
protected void	trackRuleExecution(RuleActionContext context) Tracks this rule's execution by incrementing the RuleConfigurationRRD.getCurrentRuns() for the currently executing rule.
protected void	trackRuleGroupExecution(RuleGroupExecutionRRD execution, RuleConfigurationRRD config) Updates the given RuleGroupExecutionRRD by adding the config.getRuleCode() to the execution.getExecutedRules().
protected void	trackRuleGroupExecutions(RuleActionContext context) Adds this rule's execution to all RuleGroupExecutionRRD for each of this rule's defined ruleGroups.
protected void	updateActionRAOWithConsumed(AbstractRuleActionRAO actionRAO, OrderEntryConsumedRAO orderEntryConsumedRAO) Adds given OrderEntryConsumedRAO to the AbstractRuleActionRAO.consumedEntries.
protected void	validateCurrencyIsoCode(boolean absolute, String currencyIsoCode)
protected void	validateRule(RuleActionContext context) Validates that the required meta-data is available.
protected void	validateSelectionStrategy(Collection<EntriesSelectionStrategyRPD> strategies, RuleActionContext context) Validates entriesSelectionStrategyRPDs checking if the collection is not empty, if orderEntries list of each entry of entriesSelectionStrategyRPDs is not empty and all the orderEntries are from the same Order.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractRuleExecutableSupport

public AbstractRuleExecutableSupport()

Method Detail

postProcessAction

protected void postProcessAction(AbstractRuleActionRAO actionRao,
                                 RuleActionContext context,
                                 Map<String,Object> parameters)

checkAndGetRuleContext

protected KnowledgeHelper checkAndGetRuleContext(RuleActionContext context)

Checks that the given ruleContext is of type KnowledgeHelper (i.e. drools-specific)

Parameters:

context - the RuleActionContext instance

Returns:

the KnowledgeHelper

checkArgumentAndGet

protected <T> T checkArgumentAndGet(String name,
                                    Class<T> type,
                                    Map<String,Object> properties)

validateRule

protected void validateRule(RuleActionContext context)

Validates that the required meta-data is available. Validation can be disabled by setting the property droolsruleengineservices.validate.droolsrule.rulecode to false.

Parameters:

context -

getRuleCode

protected String getRuleCode(RuleActionContext context)

Returns the rule's rule code meta data.

Parameters:

context - the context

Returns:

the rule's rule code (or null, if none is found)

getMetaDataFromRule

protected String getMetaDataFromRule(RuleActionContext context,
                                     String key)

Returns the rule's meta-data for the given key (or null). Calls toString() on the meta-data object.

Parameters:

context - the RuleActionContext instance

key - the key of the meta-data

Returns:

the string representation of the meta-data (or null)

getMetaDataFromRule

protected Map<String,String> getMetaDataFromRule(RuleActionContext context)

setRAOMetaData

public void setRAOMetaData(RuleActionContext context,
                           AbstractRuleActionRAO... raos)

addMetadataToRao

protected void addMetadataToRao(AbstractRuleActionRAO rao,
                                RuleActionContext context)

trackRuleExecution

protected void trackRuleExecution(RuleActionContext context)

Tracks this rule's execution by incrementing the RuleConfigurationRRD.getCurrentRuns() for the currently executing rule.

Parameters:

context - the drools specific context

trackRuleGroupExecutions

protected void trackRuleGroupExecutions(RuleActionContext context)

Adds this rule's execution to all RuleGroupExecutionRRD for each of this rule's defined ruleGroups. (Inserts new RuleGroupExecutionRRD if needed). Note: this method depends on the ruleCode being set in the rule, the assumption is that this method is called at the end of an action's execution, thereby assuming the rule validation has taken place already.

Parameters:

context - the drools specific rule context

trackRuleGroupExecution

protected void trackRuleGroupExecution(RuleGroupExecutionRRD execution,
                                       RuleConfigurationRRD config)

Updates the given RuleGroupExecutionRRD by adding the config.getRuleCode() to the execution.getExecutedRules().

getRuleGroupExecutionRRD

protected RuleGroupExecutionRRD getRuleGroupExecutionRRD(String ruleGroupCode,
                                                         RuleActionContext context)

retrieves the RuleGroupExecutionRRD for the given ruleGroupCode from the given context.

Parameters:

ruleGroupCode - the rule group code

context - the drools rule context

Returns:

the matching RuleGroupExecutionRRD or null if none can be found

getRuleConfigurationRRD

protected RuleConfigurationRRD getRuleConfigurationRRD(String ruleCode,
                                                       RuleActionContext context)

retrieves the RuleConfigurationRRD for the given ruleCode from the given context.

Parameters:

ruleCode - the rule code

context - the drools rule context

Returns:

the RuleConfigurationRRD or null if none (or more than one) are found

extractFact

protected <T> Optional<T> extractFact(RuleActionContext context,
                                      Predicate<Object> objectFilter)

consumeOrderEntry

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

Parameters:

orderEntryRAO - the order entry to consume

actionRAO - the action rao to add the consumed entry to

quantity - the quantity to consume

discountValue - the discount this order entry consumption gave

Returns:

the newly created consumed entry

consumeOrderEntry

protected OrderEntryConsumedRAO consumeOrderEntry(OrderEntryRAO orderEntryRAO,
                                                  AbstractRuleActionRAO actionRAO)

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

Parameters:

orderEntryRAO - the order entry to consume

actionRAO - the action rao to add the consumed entry to

Returns:

the newly created consumed entry

consumeOrderEntries

protected Set<OrderEntryConsumedRAO> consumeOrderEntries(Collection<EntriesSelectionStrategyRPD> strategies,
                                                         AbstractRuleActionRAO 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.

Parameters:

strategies - the selection strategies

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

consumeOrderEntries

protected 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.

Parameters:

selectedEntries - Order Entries to be consumed

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

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

getSelectedOrderEntryQuantities

protected Map<Integer,Integer> getSelectedOrderEntryQuantities(Collection<EntriesSelectionStrategyRPD> strategies)

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

Parameters:

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

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

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

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

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

Creates new OrderEntryConsumedRAO for given OrderEntryRAO and with given quantity.

Parameters:

orderEntryRAO - OrderEntryRAO to create consumed entry for

quantity - Consumed quantity

discountValue - the discount this order entry consumption gave

Returns:

created OrderEntryConsumedRAO

updateActionRAOWithConsumed

protected void updateActionRAOWithConsumed(AbstractRuleActionRAO actionRAO,
                                           OrderEntryConsumedRAO orderEntryConsumedRAO)

Adds given OrderEntryConsumedRAO to the AbstractRuleActionRAO.consumedEntries.

Parameters:

actionRAO - AbstractRuleActionRAO to be updated

orderEntryConsumedRAO - to be added to the AbstractRuleActionRAO

adjustUnitPrice

protected BigDecimal adjustUnitPrice(OrderEntryRAO orderEntryRao)

adjustUnitPrice

protected BigDecimal adjustUnitPrice(OrderEntryRAO orderEntryRao,
                                     int quantity)

hasEnoughQuantity

protected boolean hasEnoughQuantity(List<EntriesSelectionStrategyRPD> entriesSelectionStrategyRPDs)

Checks if all entriesSelectionStrategyRPDs have enough quantity.

Parameters:

entriesSelectionStrategyRPDs - 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(EntriesSelectionStrategyRPD entriesSelectionStrategyRPD)

Checks in total quantity of all entries in the selection strategy is enough for the quantity to consume.

Parameters:

entriesSelectionStrategyRPD - EntriesSelectionStrategyRPD to check the quantity for

Returns:

true if total quantity is enough

adjustStrategyQuantity

protected 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. 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.

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

validateSelectionStrategy

protected void validateSelectionStrategy(Collection<EntriesSelectionStrategyRPD> strategies,
                                         RuleActionContext context)

Validates entriesSelectionStrategyRPDs checking if the collection is not empty, if orderEntries list of each entry of entriesSelectionStrategyRPDs is not empty and all the orderEntries are from the same Order.

Parameters:

strategies - collection of EntriesSelectionStrategyRPD to check.

context - the RuleActionContext instance

splitEntriesSelectionStrategies

protected void splitEntriesSelectionStrategies(List<EntriesSelectionStrategyRPD> entriesSelectionStrategyRPDs,
                                               List<EntriesSelectionStrategyRPD> selectionStrategyRPDsForAction,
                                               List<EntriesSelectionStrategyRPD> selectionStrategyRPDsForTriggering)

mergeDiscounts

protected boolean mergeDiscounts(RuleActionContext context,
                                 DiscountRAO discountRao,
                                 OrderEntryRAO entry)

validateCurrencyIsoCode

protected void validateCurrencyIsoCode(boolean absolute,
                                       String currencyIsoCode)

extractAmountForCurrency

protected Optional<BigDecimal> extractAmountForCurrency(RuleActionContext context,
                                                        Object currencyAmount)

getBeanName

public String getBeanName()

setBeanName

public void setBeanName(String beanName)

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

getConfigurationService

protected ConfigurationService getConfigurationService()

setRuleEngineCalculationService

public void setRuleEngineCalculationService(RuleEngineCalculationService ruleEngineCalculationService)

getRuleEngineCalculationService

protected RuleEngineCalculationService getRuleEngineCalculationService()

getEntriesSelectionStrategies

protected Map<OrderEntrySelectionStrategy,EntriesSelectionStrategy> getEntriesSelectionStrategies()

setEntriesSelectionStrategies

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

getRuleCurrencyConverterStrategy

protected RuleCurrencyConverterStrategy getRuleCurrencyConverterStrategy()

setRuleCurrencyConverterStrategy

public void setRuleCurrencyConverterStrategy(RuleCurrencyConverterStrategy ruleCurrencyConverterStrategy)

getOrderUtils

protected OrderUtils getOrderUtils()

setOrderUtils

public void setOrderUtils(OrderUtils orderUtils)

getActionSupplementStrategies

protected List<ActionSupplementStrategy> getActionSupplementStrategies()

setActionSupplementStrategies

public void setActionSupplementStrategies(List<ActionSupplementStrategy> actionSupplementStrategies)

getRaoUtils

protected RaoUtils getRaoUtils()

setRaoUtils

public void setRaoUtils(RaoUtils raoUtils)