Class SubscriptionAdjustment

java.lang.Object
com.broadleafcommerce.orderoperation.domain.subscription.SubscriptionAdjustment
All Implemented Interfaces:
Serializable

public class SubscriptionAdjustment extends Object implements Serializable
This is a representation of a price adjustment for a Subscription.
Since:
Order Operation Service 2.2.0, Release Train 2.3.0
See Also:
  • Constructor Details

    • SubscriptionAdjustment

      public SubscriptionAdjustment()
  • Method Details

    • addAttribute

      public void addAttribute(String name, Object value)
      Takes in any additional attributes passed in the request not matching any defined properties.
      Parameters:
      name - Name of the additional attribute
      value - Value of the additional attribute
    • getAttribute

      public Map<String,Object> getAttribute()
      Return any additional attributes passed in the request not matching any defined properties.
      Returns:
      any additional attributes passed in the request not matching any defined properties.
    • getId

      public String getId()
    • getSubscriptionId

      public String getSubscriptionId()
      Reference to the Subscription whose price this adjusts
    • getAdjustmentRef

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

      public String getSubscriptionAdjustmentType()
      Type of this adjustment
      See Also:
    • getAdjustmentAmount

      public BigDecimal getAdjustmentAmount()
      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
    • getAttributes

      public Map<String,Object> getAttributes()
      Map holding any additional attributes passed in the request not matching any defined properties.
    • setId

      public void setId(String id)
    • setSubscriptionId

      public void setSubscriptionId(String subscriptionId)
      Reference to the Subscription whose price this adjusts
    • 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
      See Also:
    • setAdjustmentAmount

      public void setAdjustmentAmount(BigDecimal adjustmentAmount)
      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
    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Map holding any additional attributes passed in the request not matching any defined properties.
    • 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