Package com.broadleafcommerce.promotion.offer.client.web.context.info

Interface ProratedItemOfferAdjustment

All Known Implementing Classes:
ProratedItemOfferAdjustmentDto
public interface ProratedItemOfferAdjustment
DTO containing prorated price adjustment information for a LineItem caused by an offer targeting it or using it as a qualifier.

If an offer's discount's proration type is TARGET_AND_QUALIFIER, then the discount should be spread between target items and item qualifiers. Thus, this DTO will contain the additional adjustments created for qualifiers. Practically, this information is only needed for reporting services since the total discount is the same for the LineItem however it gets distributed amongst its individual merchandising items.

Author:
Chad Harchar (charchar), Nathan Moore (nathanmoore)

  • Method Summary

    Modifier and Type
    Method
    Description
    javax.money.MonetaryAmount
    getAmount()
    The amount of the adjustment applied to the item.
    default String
    getCodeUsed()
    The code used (if any) that triggered the application of the offer for this adjustment.
    LineItemRef
    getLineItem()
    The LineItemRef of the LineItem that gets this adjustment.
    OfferRef
    getOffer()
    The OfferRef for the offer that caused this adjustment to be applied.
    default int
    getQuantity()
    The quantity of merchandising items from the LineItem to which this adjustment applies.
    void
    setAmount(javax.money.MonetaryAmount amount)
    The amount of the adjustment applied to the item.
    default void
    setCodeUsed(String codeUsed)
    The code used (if any) that triggered the application of the offer for this adjustment.
    void
    setLineItem(LineItemRef lineItem)
    The LineItemRef of the LineItem that gets this adjustment.
    void
    setOffer(OfferRef offer)
    The OfferRef for the offer that caused this adjustment to be applied.
    default void
    setQuantity(int quantity)
    The quantity of merchandising items from the LineItem to which this adjustment applies.

  • Method Details

    • getLineItem

      LineItemRef getLineItem()
      The LineItemRef of the LineItem that gets this adjustment.
      Returns:
      The LineItemRef of the LineItem that gets this adjustment.

    • setLineItem

      void setLineItem(LineItemRef lineItem)
      The LineItemRef of the LineItem that gets this adjustment.
      Parameters:
      lineItem - The LineItemRef of the LineItem that gets this adjustment.

    • getOffer

      OfferRef getOffer()
      The OfferRef for the offer that caused this adjustment to be applied.
      Returns:
      The OfferRef for the offer that caused this adjustment to be applied.

    • setOffer

      void setOffer(OfferRef offer)
      The OfferRef for the offer that caused this adjustment to be applied.
      Parameters:
      offer - The OfferRef for the offer that caused this adjustment to be applied.

    • getAmount

      javax.money.MonetaryAmount getAmount()
      The amount of the adjustment applied to the item.
      Returns:
      The amount of the adjustment applied to the item.

    • setAmount

      void setAmount(javax.money.MonetaryAmount amount)
      The amount of the adjustment applied to the item.
      Parameters:
      amount - The amount of the adjustment applied to the item.

    • getQuantity

      default int getQuantity()
      The quantity of merchandising items from the LineItem to which this adjustment applies.
      Returns:
      The quantity of merchandising items from the LineItem to which this adjustment applies.

    • setQuantity

      default void setQuantity(int quantity)
      The quantity of merchandising items from the LineItem to which this adjustment applies.
      Parameters:
      quantity - The quantity of merchandising items from the LineItem to which this adjustment applies.

    • getCodeUsed

      default String getCodeUsed()
      The code used (if any) that triggered the application of the offer for this adjustment.
      Returns:
      The code used (if any) that triggered the application of the offer for this adjustment.

    • setCodeUsed

      default void setCodeUsed(String codeUsed)
      The code used (if any) that triggered the application of the offer for this adjustment.
      Parameters:
      codeUsed - The code used (if any) that triggered the application of the offer for this adjustment.