Package com.broadleafcommerce.cartoperation.service.provider.domain

Class RemovedAdjustment

java.lang.Object
com.broadleafcommerce.cartoperation.service.provider.domain.RemovedAdjustment
All Implemented Interfaces:
Serializable
public class RemovedAdjustment extends Object implements Serializable
Represents an Adjustment that will be lost given proposed changes to a current Subscription. This summarizes all Adjustments lost that were produced by the same offer, i.e., that share the same Adjustment.getOfferRef().
Since:
Cart Operation Service 2.3.0, Release Train 2.3.0
Author:
Nathan Moore (nathandmoore)
See Also:

  • Constructor Details

    • RemovedAdjustment

      public RemovedAdjustment()

  • Method Details

    • getAdjustmentRef

      public String getAdjustmentRef()
      Reference to the promotion or offer that drives this adjustment

    • getSubscriptionAdjustmentType

      public String getSubscriptionAdjustmentType()
      Type of this adjustment

    • getAdjustmentUnitAmount

      public BigDecimal getAdjustmentUnitAmount()
      The unit discount of an Adjustment.

    • getItemAdjustmentQuantity

      public Integer getItemAdjustmentQuantity()
      If it's an item adjustment, it represents the quantity this adjustment applies to. If null, then the full quantity of the item is targeted.

    • getAdjustmentAmountTotal

      public BigDecimal getAdjustmentAmountTotal()
      Amount of this adjustment

    • getBeginPeriod

      public Integer getBeginPeriod()
      Number of the billing period this adjustment starts being active

    • getEndPeriod

      public Integer getEndPeriod()
      Number of the billing period this adjustment stops. If this field is null, the adjustment is considered indefinite

    • getAdjustmentName

      public String getAdjustmentName()
      Name of the adjustment applied.

    • getAdjustmentCartLabel

      public String getAdjustmentCartLabel()
      Friendly label to display in the cart or to a customer in general instead of the adjustmentName.

    • getAdjustmentDescription

      public String getAdjustmentDescription()
      A description of what benefits the adjustment provides to a customer.

    • getAdjustmentProrationType

      public String getAdjustmentProrationType()
      Determines how an adjustment's discount amount is distributed across the adjustment's related item types. This can either be set to prorate across target items or target and qualifier items.

    • getAdjustmentCodeRef

      public String getAdjustmentCodeRef()
      A reference to the Offer Code (if any).

    • getCodeUsed

      public String getCodeUsed()
      The code used (if any) that triggered the application of the adjustment for this adjustment.

    • getCampaignTrackingId

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

    • getDiscountType

      public String getDiscountType()
      Defines the type of the discount. This primarily determines when it should be applied to the order or items. This helps distinguish whether the adjustment applies at checkout or later such as for a subscription.

    • getFreeTrialLength

      public Integer getFreeTrialLength()
      If discountType is FREE_TRIAL, then this defines the free trial's length.
      See Also:
      • freeTrialLengthUnits

    • getFreeTrialLengthUnits

      public String getFreeTrialLengthUnits()
      If discountType is FREE_TRIAL, then this defines the units for freeTrialLength.
      See Also:
      • freeTrialLength

    • getReasonCode

      public String getReasonCode()
      A system code used to identify the reason for the removal of the adjustment.

    • getReasonMessage

      public String getReasonMessage()
      A message to the customer specifying why the adjustment is being removed.

    • getAttributes

      public Map<String,Object> getAttributes()
      Additional information to include with this removal DTO.

    • setAdjustmentRef

      public void setAdjustmentRef(String adjustmentRef)
      Reference to the promotion or offer that drives this adjustment

    • setSubscriptionAdjustmentType

      public void setSubscriptionAdjustmentType(String subscriptionAdjustmentType)
      Type of this adjustment

    • setAdjustmentUnitAmount

      public void setAdjustmentUnitAmount(BigDecimal adjustmentUnitAmount)
      The unit discount of an Adjustment.

    • setItemAdjustmentQuantity

      public void setItemAdjustmentQuantity(Integer itemAdjustmentQuantity)
      If it's an item adjustment, it represents the quantity this adjustment applies to. If null, then the full quantity of the item is targeted.

    • setAdjustmentAmountTotal

      public void setAdjustmentAmountTotal(BigDecimal adjustmentAmountTotal)
      Amount of this adjustment

    • setBeginPeriod

      public void setBeginPeriod(Integer beginPeriod)
      Number of the billing period this adjustment starts being active

    • setEndPeriod

      public void setEndPeriod(Integer endPeriod)
      Number of the billing period this adjustment stops. If this field is null, the adjustment is considered indefinite

    • setAdjustmentName

      public void setAdjustmentName(String adjustmentName)
      Name of the adjustment applied.

    • setAdjustmentCartLabel

      public void setAdjustmentCartLabel(String adjustmentCartLabel)
      Friendly label to display in the cart or to a customer in general instead of the adjustmentName.

    • setAdjustmentDescription

      public void setAdjustmentDescription(String adjustmentDescription)
      A description of what benefits the adjustment provides to a customer.

    • setAdjustmentProrationType

      public void setAdjustmentProrationType(String adjustmentProrationType)
      Determines how an adjustment's discount amount is distributed across the adjustment's related item types. This can either be set to prorate across target items or target and qualifier items.

    • setAdjustmentCodeRef

      public void setAdjustmentCodeRef(String adjustmentCodeRef)
      A reference to the Offer Code (if any).

    • setCodeUsed

      public void setCodeUsed(String codeUsed)
      The code used (if any) that triggered the application of the adjustment for this adjustment.

    • setCampaignTrackingId

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

    • setDiscountType

      public void setDiscountType(String discountType)
      Defines the type of the discount. This primarily determines when it should be applied to the order or items. This helps distinguish whether the adjustment applies at checkout or later such as for a subscription.

    • setFreeTrialLength

      public void setFreeTrialLength(Integer freeTrialLength)
      If discountType is FREE_TRIAL, then this defines the free trial's length.
      See Also:
      • freeTrialLengthUnits

    • setFreeTrialLengthUnits

      public void setFreeTrialLengthUnits(String freeTrialLengthUnits)
      If discountType is FREE_TRIAL, then this defines the units for freeTrialLength.
      See Also:
      • freeTrialLength

    • setReasonCode

      public void setReasonCode(String reasonCode)
      A system code used to identify the reason for the removal of the adjustment.

    • setReasonMessage

      public void setReasonMessage(String reasonMessage)
      A message to the customer specifying why the adjustment is being removed.

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Additional information to include with this removal DTO.

    • 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