de.hybris.platform.warehousing.consignment.strategies

Interface ConsignmentAmountCalculationStrategy

All Known Implementing Classes:

DefaultConsignmentAmountCalculationStrategy

public interface ConsignmentAmountCalculationStrategy

This strategy provides methods to calculate amount for a ConsignmentModel to perform payment and tax related operations.

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
java.math.BigDecimal	calculateCaptureAmount(ConsignmentModel consignment) Calculates the amount to be captured for the given ConsignmentModel
java.math.BigDecimal	calculateConsignmentEntryAmount(ConsignmentEntryModel consignmentEntry, boolean includeTaxes) Calculates amount for ConsignmentEntryModel
java.math.BigDecimal	calculateDiscountAmount(ConsignmentModel consignment) Calculates the discount amount for the ConsignmentModel taking a part of AbstractOrderModel.TOTALDISCOUNTS
java.math.BigDecimal	calculateTotalOrderAmount(ConsignmentModel consignment) Calculates the order total of the given ConsignmentModel

Method Detail

calculateCaptureAmount

java.math.BigDecimal calculateCaptureAmount(ConsignmentModel consignment)

Calculates the amount to be captured for the given ConsignmentModel

Parameters:

consignment - given ConsignmentModel

Returns:

the amount to be captured for the given ConsignmentModel

calculateAlreadyCapturedAmount

java.math.BigDecimal calculateAlreadyCapturedAmount(ConsignmentModel consignment)

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

Parameters:

consignment - given ConsignmentModel

Returns:

BigDecimal the sum of all previously captured amount

calculateTotalOrderAmount

java.math.BigDecimal calculateTotalOrderAmount(ConsignmentModel consignment)

Calculates the order total of the given ConsignmentModel

Parameters:

consignment - given ConsignmentModel

Returns:

BigDecimal the order total

calculateDiscountAmount

java.math.BigDecimal calculateDiscountAmount(ConsignmentModel consignment)

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

Parameters:

consignment - given ConsignmentModel

Returns:

BigDecimal the discount for the give consignment

calculateConsignmentEntryAmount

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

Calculates amount for ConsignmentEntryModel

Parameters:

consignmentEntry - given ConsignmentEntryModel

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

Returns:

BigDecimal amount of the consignment entry