Package com.broadleafcommerce.orderoperation.domain.subscription

Class SubscriptionItemAdjustment

java.lang.Object
com.broadleafcommerce.orderoperation.domain.subscription.SubscriptionItemAdjustment
All Implemented Interfaces:
Serializable
public class SubscriptionItemAdjustment extends Object implements Serializable
This represents a line item price adjustment for a Subscription.
Since:
Order Operation Service 2.2.0, Release Train 2.3.0
See Also:

  • Constructor Details

    • SubscriptionItemAdjustment

      public SubscriptionItemAdjustment()

  • Method Details

    • addAdditionalAttribute

      public void addAdditionalAttribute(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

    • getAdditionalAttributes

      public Map<String,Object> getAdditionalAttributes()
      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()

    • getSubscriptionItemId

      public String getSubscriptionItemId()
      Reference to the SubscriptionItem whose price this adjusts

    • getAdjustmentRef

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

    • getSubscriptionAdjustmentType

      public String getSubscriptionAdjustmentType()
      Type of adjustment that this adds
      See Also:

    • getAdjustmentAmount

      public BigDecimal getAdjustmentAmount()
      Amount of the price 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()
      Miscellaneous attributes for this subscription item adjustment.

    • setId

      public void setId(String id)

    • setSubscriptionItemId

      public void setSubscriptionItemId(String subscriptionItemId)
      Reference to the SubscriptionItem 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 adjustment that this adds
      See Also:

    • setAdjustmentAmount

      public void setAdjustmentAmount(BigDecimal adjustmentAmount)
      Amount of the price 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)
      Miscellaneous attributes for this subscription item adjustment.

    • setAdditionalAttributes

      public void setAdditionalAttributes(Map<String,Object> additionalAttributes)
      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