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

Class Adjustment

java.lang.Object
com.broadleafcommerce.promotion.offer.client.web.context.info.Adjustment
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
ItemAdjustment
public class Adjustment extends Object implements Serializable
An adjustment made to any part of the order. Provides details on the adjustment amount, the corresponding offer, and whether this adjustment is for a future credit.
Author:
Chad Harchar (charchar)
See Also:

  • Constructor Details

    • Adjustment

      public Adjustment()

  • Method Details

    • setType

      public void setType(String type)
      See Also:
      • type

    • getType

      public String getType()
      See Also:
      • type

    • setFutureCredit

      @Deprecated(since="Offer Client 2.0.2", forRemoval=true) public void setFutureCredit(boolean isFutureCredit)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use setType(String)
      Sets the isFutureCredit flag.

      Since this flag is not deprecated and for the sake of backwards compatibility, this method will also set type. If isFutureCredit is true, then this method both sets the flag to true and then type to DefaultAdjustmentType.FUTURE_CREDIT. Else, the flag is set to false and then type is set to DefaultAdjustmentType.ORDER_DISCOUNT since no other type was possible in earlier versions when isFutureCredit was still in use.

      Parameters:
      isFutureCredit - The new value to set for isFutureCredit.
      See Also:
      • isFutureCredit

    • isFutureCredit

      @Deprecated(since="Offer Client 2.0.2", forRemoval=true) public boolean isFutureCredit()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Use getType()
      Returns the value of isFutureCredit.

      Since that flag is not deprecated, this will check if type is DefaultAdjustmentType.FUTURE_CREDIT as well for backwards compatibility.

      See Also:
      • isFutureCredit

    • getOfferRef

      public OfferRef getOfferRef()
      A reference to the OfferRef.

    • getOfferCodeRef

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

    • getAdjustmentAmount

      public javax.money.MonetaryAmount getAdjustmentAmount()
      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.

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

    • getItemAdjustmentQuantity

      public int getItemAdjustmentQuantity()
      The quantity of the current line item that this offer was applied to.

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

    • getServiceLevel

      public String getServiceLevel()
      The serviceLevel that this adjustment applies to (typically used only with fulfillment group offers to indicate that the discount applies to the portion of the fulfillment price related to a specific service level. For example, for a group containing some items shipped by STANDARD and some as EXPRESS it is possible the discount only applies to the EXPRESS items. A blank value would indicate the discount applies to all service levels.

    • getFreeTrialLength

      public int getFreeTrialLength()
      If type is DefaultAdjustmentType.FREE_TRIAL, then this defines the free trial's length.
      Since:
      Offer Client 2.0.2
      See Also:
      • freeTrialLengthUnits

    • getFreeTrialLengthUnits

      public String getFreeTrialLengthUnits()
      If type is DefaultAdjustmentType.FREE_TRIAL, then this defines the units for freeTrialLength. Default is DefaultFreeTrialLengthUnits.DAYS.
      Since:
      Offer Client 2.0.2
      See Also:

    • getBeginPeriod

      public int getBeginPeriod()
      If type is DefaultAdjustmentType.RECURRING_DISCOUNT, this is the beginning period for the discount. 1 refers to the first recurring billing period, and so on.
      Since:
      Offer Client 2.0.2

    • getEndPeriod

      public Integer getEndPeriod()
      If type is DefaultAdjustmentType.RECURRING_DISCOUNT, this is the ending period for the discount. 1 refers to the first recurring billing period, and so on.
      Since:
      Offer Client 2.0.2

    • setOfferRef

      public void setOfferRef(OfferRef offerRef)
      A reference to the OfferRef.

    • setOfferCodeRef

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

    • setAdjustmentAmount

      public void setAdjustmentAmount(javax.money.MonetaryAmount adjustmentAmount)
      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.

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

    • setItemAdjustmentQuantity

      public void setItemAdjustmentQuantity(int itemAdjustmentQuantity)
      The quantity of the current line item that this offer was applied to.

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

    • setServiceLevel

      public void setServiceLevel(String serviceLevel)
      The serviceLevel that this adjustment applies to (typically used only with fulfillment group offers to indicate that the discount applies to the portion of the fulfillment price related to a specific service level. For example, for a group containing some items shipped by STANDARD and some as EXPRESS it is possible the discount only applies to the EXPRESS items. A blank value would indicate the discount applies to all service levels.

    • setFreeTrialLength

      public void setFreeTrialLength(int freeTrialLength)
      If type is DefaultAdjustmentType.FREE_TRIAL, then this defines the free trial's length.
      Since:
      Offer Client 2.0.2
      See Also:
      • freeTrialLengthUnits

    • setFreeTrialLengthUnits

      public void setFreeTrialLengthUnits(String freeTrialLengthUnits)
      If type is DefaultAdjustmentType.FREE_TRIAL, then this defines the units for freeTrialLength. Default is DefaultFreeTrialLengthUnits.DAYS.
      Since:
      Offer Client 2.0.2
      See Also:

    • setBeginPeriod

      public void setBeginPeriod(int beginPeriod)
      If type is DefaultAdjustmentType.RECURRING_DISCOUNT, this is the beginning period for the discount. 1 refers to the first recurring billing period, and so on.
      Since:
      Offer Client 2.0.2

    • setEndPeriod

      public void setEndPeriod(Integer endPeriod)
      If type is DefaultAdjustmentType.RECURRING_DISCOUNT, this is the ending period for the discount. 1 refers to the first recurring billing period, and so on.
      Since:
      Offer Client 2.0.2

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object