de.hybris.platform.warehousing.consignment.strategies.impl

Class DefaultConsignmentAmountCalculationStrategy

java.lang.Object

de.hybris.platform.warehousing.consignment.strategies.impl.DefaultConsignmentAmountCalculationStrategy

All Implemented Interfaces:

ConsignmentAmountCalculationStrategy

public class DefaultConsignmentAmountCalculationStrategy
extends java.lang.Object
implements ConsignmentAmountCalculationStrategy

Default implementation for ConsignmentAmountCalculationStrategy

Constructor Summary

Constructors

Constructor and Description
DefaultConsignmentAmountCalculationStrategy()

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	calculateAlreadyCapturedAmount(ConsignmentModel consignment) Calculates the amount which has been already captured on the OrderModel of the given ConsignmentModel
protected java.math.BigDecimal	calculateAmountCaptured(ConsignmentModel consignment) Calculates amount already captured for the given ConsignmentModel
protected java.math.BigDecimal	calculateAmountToCapture(ConsignmentModel consignment, java.math.BigDecimal alreadyCapturedAmount, java.math.BigDecimal totalOrderAmount) Calculates the amount to capture.
java.math.BigDecimal	calculateCaptureAmount(ConsignmentModel consignment) Calculates the amount to be captured for the given ConsignmentModel
protected java.math.BigDecimal	calculateConsignmentAmount(ConsignmentModel consignment, boolean includeTaxes) Calculates the amount of the ConsignmentModel based on the appropriate AbstractOrderEntryModel.TOTALPRICE
java.math.BigDecimal	calculateConsignmentEntryAmount(ConsignmentEntryModel consignmentEntry, boolean includeTaxes) Calculates amount for ConsignmentEntryModel
protected java.math.BigDecimal	calculateConsignmentEntryTaxAmount(ConsignmentEntryModel consignmentEntry) Calculates Tax amount for ConsignmentEntryModel
java.math.BigDecimal	calculateDiscountAmount(ConsignmentModel consignment) Calculates the discount amount for the ConsignmentModel taking a part of AbstractOrderModel.TOTALDISCOUNTS
protected java.math.BigDecimal	calculateDiscountAmountForConsignment(ConsignmentModel consignment) Calculates discount amount for ConsignmentModel by taking a proportional part of AbstractOrderModel.TOTALDISCOUNTS.
protected java.math.BigDecimal	calculateOrderAmountWithoutDeliveryCostAndDeliveryTax(ConsignmentModel consignment) Calculates order amount without delivery cost and its corresponding tax
java.math.BigDecimal	calculateTotalOrderAmount(ConsignmentModel consignment) Calculates the order total of the given ConsignmentModel
protected boolean	isOnlyOrLastConsignment(ConsignmentModel consignment) Decides if this ConsignmentModel is the only or last one to be captured

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultConsignmentAmountCalculationStrategy

public DefaultConsignmentAmountCalculationStrategy()

Method Detail

calculateCaptureAmount

public java.math.BigDecimal calculateCaptureAmount(ConsignmentModel consignment)

Description copied from interface: ConsignmentAmountCalculationStrategy

Calculates the amount to be captured for the given ConsignmentModel

Specified by:

calculateCaptureAmount in interface ConsignmentAmountCalculationStrategy

Parameters:

consignment - given ConsignmentModel

Returns:

the amount to be captured for the given ConsignmentModel

calculateAlreadyCapturedAmount

public java.math.BigDecimal calculateAlreadyCapturedAmount(ConsignmentModel consignment)

Description copied from interface: ConsignmentAmountCalculationStrategy

Calculates the amount which has been already captured on the OrderModel of the given ConsignmentModel

Specified by:

calculateAlreadyCapturedAmount in interface ConsignmentAmountCalculationStrategy

Parameters:

consignment - given ConsignmentModel

Returns:

BigDecimal the sum of all previously captured amount

calculateTotalOrderAmount

public java.math.BigDecimal calculateTotalOrderAmount(ConsignmentModel consignment)

Description copied from interface: ConsignmentAmountCalculationStrategy

Calculates the order total of the given ConsignmentModel

Specified by:

calculateTotalOrderAmount in interface ConsignmentAmountCalculationStrategy

Parameters:

consignment - given ConsignmentModel

Returns:

BigDecimal the order total

calculateDiscountAmount

public java.math.BigDecimal calculateDiscountAmount(ConsignmentModel consignment)

Description copied from interface: ConsignmentAmountCalculationStrategy

Calculates the discount amount for the ConsignmentModel taking a part of AbstractOrderModel.TOTALDISCOUNTS

Specified by:

calculateDiscountAmount in interface ConsignmentAmountCalculationStrategy

Parameters:

consignment - given ConsignmentModel

Returns:

BigDecimal the discount for the give consignment

calculateConsignmentEntryAmount

public java.math.BigDecimal calculateConsignmentEntryAmount(ConsignmentEntryModel consignmentEntry,
                                                            boolean includeTaxes)

Description copied from interface: ConsignmentAmountCalculationStrategy

Calculates amount for ConsignmentEntryModel

Specified by:

calculateConsignmentEntryAmount in interface ConsignmentAmountCalculationStrategy

Parameters:

consignmentEntry - given ConsignmentEntryModel

includeTaxes - if true returns the amount with taxes otherwise - without taxes

Returns:

BigDecimal amount of the consignment entry

calculateDiscountAmountForConsignment

protected java.math.BigDecimal calculateDiscountAmountForConsignment(ConsignmentModel consignment)

Calculates discount amount for ConsignmentModel by taking a proportional part of AbstractOrderModel.TOTALDISCOUNTS. Returns the discount value without taking into account if it's the last consignment

Parameters:

consignment - ConsignmentModel to calculate discount

Returns:

BigDecimal the discount amount

isOnlyOrLastConsignment

protected boolean isOnlyOrLastConsignment(ConsignmentModel consignment)

Decides if this ConsignmentModel is the only or last one to be captured

Parameters:

consignment - given ConsignmentModel

Returns:

true if the given ConsignmentModel is the only one or the last one to be captured

calculateAmountToCapture

protected java.math.BigDecimal calculateAmountToCapture(ConsignmentModel consignment,
                                                        java.math.BigDecimal alreadyCapturedAmount,
                                                        java.math.BigDecimal totalOrderAmount)

Calculates the amount to capture. Takes into account the amount which has been already captured and the order total so that the result never exceeds the order total.

Parameters:

consignment - given ConsignmentModel

alreadyCapturedAmount - the amount which has been already captured

totalOrderAmount - the order total

Returns:

BigDecimal amount to be captured on this consignment

calculateConsignmentAmount

protected java.math.BigDecimal calculateConsignmentAmount(ConsignmentModel consignment,
                                                          boolean includeTaxes)

Calculates the amount of the ConsignmentModel based on the appropriate AbstractOrderEntryModel.TOTALPRICE

Parameters:

consignment - given ConsignmentModel

includeTaxes - if true returns the amount with taxes otherwise - without taxes

Returns:

BigDecimal the cost of the consignment

calculateConsignmentEntryTaxAmount

protected java.math.BigDecimal calculateConsignmentEntryTaxAmount(ConsignmentEntryModel consignmentEntry)

Calculates Tax amount for ConsignmentEntryModel

Parameters:

consignmentEntry - given ConsignmentEntryModel

Returns:

BigDecimal amount of the consignment entry

calculateAmountCaptured

protected java.math.BigDecimal calculateAmountCaptured(ConsignmentModel consignment)

Calculates amount already captured for the given ConsignmentModel

Parameters:

consignment - the given ConsignmentModel

Returns:

BigDecimal amount captured for the consignment

calculateOrderAmountWithoutDeliveryCostAndDeliveryTax

protected java.math.BigDecimal calculateOrderAmountWithoutDeliveryCostAndDeliveryTax(ConsignmentModel consignment)

Calculates order amount without delivery cost and its corresponding tax

Parameters:

consignment -

Returns:

BigDecimal order amount for the consignment