de.hybris.platform.ruleengineservices.calculation

Interface RuleEngineCalculationService

All Known Implementing Classes:

DefaultRuleEngineCalculationService

public interface RuleEngineCalculationService

RuleEngineCalculationService provides methods related to order and cart calculation to be used during rule evaluation.

Method Summary

Modifier and Type	Method and Description
java.util.List<DiscountRAO>	addFixedPriceEntriesDiscount(CartRAO cartRao, java.util.Map<java.lang.Integer,java.lang.Integer> selectedOrderEntryMap, java.util.Set<OrderEntryRAO> selectedOrderEntryRaos, java.math.BigDecimal fixedPrice) Creates order entry level discounts for the cart cartRao, with the fixedPrice given as parameter and for the products from entries in selectedOrderEntryRaos and related quantities given in selectedOrderEntryMap.
DiscountRAO	addFixedPriceEntryDiscount(OrderEntryRAO orderEntryRao, java.math.BigDecimal fixedPrice) Creates a new order entry level discount such that the order entry's price will be equal to the given fixedPrice multiplied by quantity.
DiscountRAO	addFixedPriceEntryDiscountStackable(OrderEntryRAO orderEntryRao, java.math.BigDecimal fixedPrice) Deprecated. since 6.7
FreeProductRAO	addFreeProductsToCart(CartRAO cartRao, ProductModel product, int quantity) Adds free product items to the cart.
java.util.List<DiscountRAO>	addOrderEntryLevelDiscount(java.util.Map<java.lang.Integer,java.lang.Integer> selectedOrderEntryMap, java.util.Set<OrderEntryRAO> selectedOrderEntryRaos, boolean absolute, java.math.BigDecimal amount) Creates order entry level discounts for the cart cartRao, adds it to the cartRao and updates the cartRao totals.
DiscountRAO	addOrderEntryLevelDiscount(OrderEntryRAO orderEntryRao, boolean absolute, java.math.BigDecimal amount) Creates a new order entry level discount based on the given values, adds it to the corresponding orderRao and updates the orderRao totals.
DiscountRAO	addOrderEntryLevelDiscountStackable(OrderEntryRAO orderEntryRao, boolean absolute, java.math.BigDecimal amount) Deprecated. since 6.7
DiscountRAO	addOrderLevelDiscount(CartRAO cartRao, boolean absolute, java.math.BigDecimal amount) Creates a new order level discount based on the given values, adds it to the cartRao and updates the cartRao totals.
java.math.BigDecimal	calculateSubTotals(CartRAO cartRao, java.util.Collection<ProductRAO> excludedProducts) Runs cart calculation for cart not including the excluded products.
void	calculateTotals(AbstractOrderRAO abstractOrderRao) performs a (re)calculation on the given abstractOrderRao and updates these properties: AbstractOrderRAO.getTotal() AbstractOrderRAO.getSubTotal() AbstractOrderRAO.getDeliveryCost() AbstractOrderRAO.getPaymentCost()
ShipmentRAO	changeDeliveryMode(CartRAO cartRAO, DeliveryModeRAO deliveryModeRAO) Changes the current delivery mode to the given values, adds it to the cartRao and updates the carRao totals.
java.math.BigDecimal	getAdjustedUnitPrice(int quantity, OrderEntryRAO orderEntryRao) Gets the total discount for line item and recalculates the discounted unit price.
int	getConsumedQuantityForOrderEntry(OrderEntryRAO orderEntryRao) Return consumed quantity for a given order entry
java.math.BigDecimal	getCurrentPrice(java.util.Set<OrderEntryRAO> orderEntryForDiscounts, java.util.Map<java.lang.Integer,java.lang.Integer> discountedOrderEntryMap) Calculates current price of the set of Order Entries using only specified quantity of units for every Order Entry.
<T extends AbstractOrderRAO> int	getOrderTotalAvailableQuantity(T orderRAO) Deprecated. since 6.7
int	getProductAvailableQuantityInOrderEntry(OrderEntryRAO orderEntryRAO) give the order entry and the product, return the number of available product items to consume

Method Detail

calculateTotals

void calculateTotals(AbstractOrderRAO abstractOrderRao)

performs a (re)calculation on the given abstractOrderRao and updates these properties:

• AbstractOrderRAO.getTotal()
• AbstractOrderRAO.getSubTotal()
• AbstractOrderRAO.getDeliveryCost()
• AbstractOrderRAO.getPaymentCost()

Parameters:

abstractOrderRao - the abstractOrderRao to calculate

addOrderLevelDiscount

DiscountRAO addOrderLevelDiscount(CartRAO cartRao,
                                  boolean absolute,
                                  java.math.BigDecimal amount)

Creates a new order level discount based on the given values, adds it to the cartRao and updates the cartRao totals. If the absolute flag is set to true, the discount is absolute, otherwise its a percentage based discount.

Parameters:

cartRao - the cartRao to add the discount to

absolute - whether the discount is absolute or percentage-based

amount - the amount of the discount

Returns:

the created DiscountRAO

addOrderEntryLevelDiscount

DiscountRAO addOrderEntryLevelDiscount(OrderEntryRAO orderEntryRao,
                                       boolean absolute,
                                       java.math.BigDecimal amount)

Creates a new order entry level discount based on the given values, adds it to the corresponding orderRao and updates the orderRao totals. If the absolute flag is set to true, the discount is absolute, otherwise its a percentage based discount.

Parameters:

orderEntryRao - the orderEntryRao to add the discount to

absolute - whether the discount is absolute or percentage-based

amount - the amount of the discount

Returns:

the created DiscountRAO

addOrderEntryLevelDiscountStackable

@Deprecated
DiscountRAO addOrderEntryLevelDiscountStackable(OrderEntryRAO orderEntryRao,
                                                            boolean absolute,
                                                            java.math.BigDecimal amount)

Deprecated. since 6.7

Creates a new order entry level discount for stackable rule action based on the given values, adds it to the corresponding orderRao and updates the orderRao totals. If the absolute flag is set to true, the discount is absolute, otherwise its a percentage based discount.

Parameters:

orderEntryRao - the orderEntryRao to add the discount to

absolute - whether the discount is absolute or percentage-based

amount - the amount of the discount

Returns:

the created DiscountRAO

changeDeliveryMode

ShipmentRAO changeDeliveryMode(CartRAO cartRAO,
                               DeliveryModeRAO deliveryModeRAO)

Changes the current delivery mode to the given values, adds it to the cartRao and updates the carRao totals.

Parameters:

cartRAO - the cartRao to change the delivery mode for

deliveryModeRAO - the new delivery mode

Returns:

the ShipmentRAO

addFreeProductsToCart

FreeProductRAO addFreeProductsToCart(CartRAO cartRao,
                                     ProductModel product,
                                     int quantity)

Adds free product items to the cart.

Parameters:

cartRao - cart where to add the product

product - a product to add

quantity - quantity of product items to add

Returns:

FreeProductRAO the free product to be given

addFixedPriceEntryDiscount

DiscountRAO addFixedPriceEntryDiscount(OrderEntryRAO orderEntryRao,
                                       java.math.BigDecimal fixedPrice)

Creates a new order entry level discount such that the order entry's price will be equal to the given fixedPrice multiplied by quantity.

Parameters:

orderEntryRao - the orderEntryRao to add the discount to

fixedPrice - the target unit price

Returns:

the created DiscountRAO

addFixedPriceEntryDiscountStackable

@Deprecated
DiscountRAO addFixedPriceEntryDiscountStackable(OrderEntryRAO orderEntryRao,
                                                            java.math.BigDecimal fixedPrice)

Deprecated. since 6.7

Creates a new order entry level discount for stackable rule action such that the order entry's price will be equal to the given fixedPrice multiplied by quantity.

Parameters:

orderEntryRao - the orderEntryRao to add the discount to

fixedPrice - the target unit price

Returns:

the created DiscountRAO

calculateSubTotals

java.math.BigDecimal calculateSubTotals(CartRAO cartRao,
                                        java.util.Collection<ProductRAO> excludedProducts)

Runs cart calculation for cart not including the excluded products. CartRao argument is not modified by this process.

Parameters:

cartRao - Cart to be calculated

excludedProducts - List of products to be excluded from the cart calculation

Returns:

BigDecimal result of the cartSubTotals (without charges like payment or delivery) minus the excluded products

getCurrentPrice

java.math.BigDecimal getCurrentPrice(java.util.Set<OrderEntryRAO> orderEntryForDiscounts,
                                     java.util.Map<java.lang.Integer,java.lang.Integer> discountedOrderEntryMap)

Calculates current price of the set of Order Entries using only specified quantity of units for every Order Entry.

Parameters:

orderEntryForDiscounts - set with Order Entries which price need to be calculated

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

Returns:

BigDecimal current price

getAdjustedUnitPrice

java.math.BigDecimal getAdjustedUnitPrice(int quantity,
                                          OrderEntryRAO orderEntryRao)

Gets the total discount for line item and recalculates the discounted unit price.

Parameters:

quantity - quantity of line item

orderEntryRao - orderEntryRao to get discounted unit price for

Returns:

adjusted unit price

addFixedPriceEntriesDiscount

java.util.List<DiscountRAO> addFixedPriceEntriesDiscount(CartRAO cartRao,
                                                         java.util.Map<java.lang.Integer,java.lang.Integer> selectedOrderEntryMap,
                                                         java.util.Set<OrderEntryRAO> selectedOrderEntryRaos,
                                                         java.math.BigDecimal fixedPrice)

Creates order entry level discounts for the cart cartRao, with the fixedPrice given as parameter and for the products from entries in selectedOrderEntryRaos and related quantities given in selectedOrderEntryMap.

Parameters:

cartRao - Cart RAO used for totals calculations

selectedOrderEntryMap - Map having orderEntry.entryNumber as keys and unit quantity to be consumed as values

selectedOrderEntryRaos - Order entries to be discounted

fixedPrice - Target price for discounted product

Returns:

List of discounts that are generated

addOrderEntryLevelDiscount

java.util.List<DiscountRAO> addOrderEntryLevelDiscount(java.util.Map<java.lang.Integer,java.lang.Integer> selectedOrderEntryMap,
                                                       java.util.Set<OrderEntryRAO> selectedOrderEntryRaos,
                                                       boolean absolute,
                                                       java.math.BigDecimal amount)

Creates order entry level discounts for the cart cartRao, adds it to the cartRao and updates the cartRao totals. Discounts are applied to entries contained within the selectedOrderEntryMap selectedOrderEntryRaos based on strategy.

Parameters:

selectedOrderEntryMap - Map having orderEntry.entryNumber as keys and unit quantity to be consumed as values

selectedOrderEntryRaos - Order entries to be discounted

absolute - boolean value true is discount is absolute currency amount

amount - value of discount

Returns:

List of discounts created as a result of this action

getConsumedQuantityForOrderEntry

int getConsumedQuantityForOrderEntry(OrderEntryRAO orderEntryRao)

Return consumed quantity for a given order entry

Parameters:

orderEntryRao - Cart order entry

Returns:

consumed quantity

getOrderTotalAvailableQuantity

@Deprecated
<T extends AbstractOrderRAO> int getOrderTotalAvailableQuantity(T orderRAO)

Deprecated. since 6.7

Given the order, return the total available quantity of items

Parameters:

orderRAO - instance of AbstractOrderRAO

Returns:

total number of items available for consumption

getProductAvailableQuantityInOrderEntry

int getProductAvailableQuantityInOrderEntry(OrderEntryRAO orderEntryRAO)

give the order entry and the product, return the number of available product items to consume

Parameters:

orderEntryRAO - instance of OrderEntryRAO

Returns:

total number of product items to consume