PromotableOrderItemPriceDetailAdjustment (BroadleafCommerce Framework 4.0.22-GA API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

PromotableOrderItemPriceDetailAdjustmentImpl
```
public interface PromotableOrderItemPriceDetailAdjustment
extends Serializable
```
This class holds adjustment records during the discount calculation processing. This and other disposable objects avoid churn on the database while the offer engine determines the best offer(s) for the order being priced.

Author:

bpolster

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`PromotableOrderItemPriceDetailAdjustment`	`copy()` Copy this adjustment.
`void`	`finalizeAdjustment(boolean useSalePrice)` Sets the adjustment price based on the passed in parameter.
`Money`	`getAdjustmentValue()` Returns the value of this adjustment.
`Offer`	`getOffer()` Returns the associated promotableCandidateItemOffer
`Long`	`getOfferId()` Returns the id of the contained offer.
`PromotableOrderItemPriceDetail`	`getPromotableOrderItemPriceDetail()` Returns the associated promotableOrderItemPriceDetail
`Money`	`getRetailAdjustmentValue()` Returns the value of this adjustment if only retail prices can be used.
`Money`	`getSaleAdjustmentValue()` Returns the value of this adjustment if sale prices can be used.
`boolean`	`isAppliedToSalePrice()` Returns true if the value was applied to the sale price.
`boolean`	`isCombinable()` Returns true if this adjustment represents a combinable offer.
`boolean`	`isTotalitarian()` Returns true if this adjustment represents a totalitarian offer.

- Method Detail
  - getPromotableOrderItemPriceDetail
```
PromotableOrderItemPriceDetail getPromotableOrderItemPriceDetail()
```
    Returns the associated promotableOrderItemPriceDetail
    
    Returns:
  - getOffer
```
Offer getOffer()
```
    Returns the associated promotableCandidateItemOffer
    
    Returns:
  - getRetailAdjustmentValue
```
Money getRetailAdjustmentValue()
```
    Returns the value of this adjustment if only retail prices can be used.
    
    Returns:
  - getSaleAdjustmentValue
```
Money getSaleAdjustmentValue()
```
    Returns the value of this adjustment if sale prices can be used.
    
    Returns:
  - getAdjustmentValue
```
Money getAdjustmentValue()
```
    Returns the value of this adjustment. can be used.
    
    Returns:
  - isAppliedToSalePrice
```
boolean isAppliedToSalePrice()
```
    Returns true if the value was applied to the sale price.
    
    Returns:
  - isCombinable
```
boolean isCombinable()
```
    Returns true if this adjustment represents a combinable offer.
  - isTotalitarian
```
boolean isTotalitarian()
```
    Returns true if this adjustment represents a totalitarian offer.
  - getOfferId
```
Long getOfferId()
```
    Returns the id of the contained offer.
    
    Returns:
  - finalizeAdjustment
```
void finalizeAdjustment(boolean useSalePrice)
```
    Sets the adjustment price based on the passed in parameter.
  - copy
```
PromotableOrderItemPriceDetailAdjustment copy()
```
    Copy this adjustment. Used when a detail that contains this adjustment needs to be split.
    
    Parameters:
    
    discountQty -
    
    copy -
    
    Returns:

Interface PromotableOrderItemPriceDetailAdjustment

Method Summary

Method Detail

getPromotableOrderItemPriceDetail

getOffer

getRetailAdjustmentValue

getSaleAdjustmentValue

getAdjustmentValue

isAppliedToSalePrice

isCombinable

isTotalitarian

getOfferId

finalizeAdjustment

copy