Package com.broadleafcommerce.order.common.domain

Class Adjustment

  • All Implemented Interfaces:
    Serializable
    public class Adjustment
extends Object
implements Serializable
    An adjustment to be applied to the original price of the containing entity. Typically, this could be applied to a cart, order, fulfillment, or their items.
    Author:
    Chad Harchar (charchar)
    See Also:
    Serialized Form

    • Constructor Detail

      • Adjustment

        public Adjustment()

    • Method Detail

      • getOfferRef

        public OfferRef getOfferRef()
        A reference to the offer that originated this adjustment.
        Returns:
        A reference to the offer that originated this adjustment.

      • getOfferCodeRef

        public String getOfferCodeRef()
        A reference to the OfferCode (if any).

      • getAmount

        public javax.money.MonetaryAmount getAmount()
        The amount of this adjustment.
        Returns:
        The amount of this adjustment.

      • getCodeUsed

        public 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.

      • getAlternateAdjustmentSource

        public String getAlternateAdjustmentSource()
        If this adjustment is not created by an offer this parameter will specify the source of adjustment.
        Returns:
        the source of the adjustment.
        See Also:
        DefaultAlternateAdjustmentSource

      • getQualifierDetails

        public List<OfferItemDetail> getQualifierDetails()
        A list of OfferItemDetails representing the qualifier items where this adjustment was from.

        For example, ItemA and ItemB qualify for a free gift offer, which results Item_FG to be added as a free gift item. These details are used to identify ItemA and ItemB from free gift item Item_FG using its adjustment.

        Take another example, ItemA qualifies for a Buy 1 itemA Get 1 itemB free offer. These details are used to identity the qualifier item ItemA from target item ItemB.

      • getQuantityPerUsage

        public int getQuantityPerUsage()
        The quantity per offer usage of the target item that this adjustment is for.

      • getOfferUses

        public int getOfferUses()
        The number of times that the offer this adjustment was created from is applied.

      • getCampaignTrackingId

        public String getCampaignTrackingId()
        The campaign tracking id (if any) for this adjustment.

      • setOfferRef

        public void setOfferRef​(OfferRef offerRef)
        A reference to the offer that originated this adjustment.
        Parameters:
        offerRef - A reference to the offer that originated this adjustment.

      • setOfferCodeRef

        public void setOfferCodeRef​(String offerCodeRef)
        A reference to the OfferCode (if any).

      • setAmount

        public void setAmount​(javax.money.MonetaryAmount amount)
        The amount of this adjustment.
        Parameters:
        amount - The amount of this adjustment.

      • setCodeUsed

        public 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.

      • setAlternateAdjustmentSource

        public void setAlternateAdjustmentSource​(String alternateAdjustmentSource)
        If this adjustment is not created by an offer this parameter will specify the source of adjustment.
        Parameters:
        alternateAdjustmentSource - the source of the adjustment.
        See Also:
        DefaultAlternateAdjustmentSource

      • setQualifierDetails

        public void setQualifierDetails​(List<OfferItemDetail> qualifierDetails)
        A list of OfferItemDetails representing the qualifier items where this adjustment was from.

        For example, ItemA and ItemB qualify for a free gift offer, which results Item_FG to be added as a free gift item. These details are used to identify ItemA and ItemB from free gift item Item_FG using its adjustment.

        Take another example, ItemA qualifies for a Buy 1 itemA Get 1 itemB free offer. These details are used to identity the qualifier item ItemA from target item ItemB.

      • setQuantityPerUsage

        public void setQuantityPerUsage​(int quantityPerUsage)
        The quantity per offer usage of the target item that this adjustment is for.

      • setOfferUses

        public void setOfferUses​(int offerUses)
        The number of times that the offer this adjustment was created from is applied.

      • setCampaignTrackingId

        public void setCampaignTrackingId​(String campaignTrackingId)
        The campaign tracking id (if any) for this adjustment.

      • canEqual

        protected boolean canEqual​(Object other)

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object