Package com.broadleafcommerce.subscriptionoperation.domain

Class SubscriptionActionPriceDetail

java.lang.Object
com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail
All Implemented Interfaces:
Serializable
public class SubscriptionActionPriceDetail extends Object implements Serializable
Describes the amount being charged for this item. This may be an amount due now, or a future payment.
See Also:

  • Constructor Details

    • SubscriptionActionPriceDetail

      public SubscriptionActionPriceDetail()

  • Method Details

    • getCartItemId

      public String getCartItemId()
      Reference to the subscription CartItem. If the subscription item has been removed as part of the action, then this value will be null.

    • getItemRefType

      public String getItemRefType()
      Type of item that this object represents. For example, BLC_PRODUCT.

    • getItemRef

      public String getItemRef()
      Reference to the id of the item represented by this object. For example, the product id.

    • getItemName

      public String getItemName()
      Name of the item identified by getItemRefType() & getItemRef().

    • getParentItemRefType

      public String getParentItemRefType()
      Type of the parent subscription item's backing item if this is a child subscription item.

    • getParentItemRef

      public String getParentItemRef()
      Reference of the parent subscription item's backing item if this is a child subscription item.

    • getPreActionSubtotal

      public javax.money.MonetaryAmount getPreActionSubtotal()
      The subscription item subtotal prior to the action being taken, reflecting the typical recurring price for the item. For a DefaultSubscriptionActionFlow.CREATE action, this value will be null since there was no prior subscription.

      This subtotal does include the recurring discounts, however it only includes the discounts applicable to the current period. For example, if you have a discountA that is applicable from period 1-3 and a discountB that is applicable from period 4-6 (although rare), then only discountA will be included in this subtotal if you are modifying the subscription in period 2.

    • getPostActionSubtotal

      public javax.money.MonetaryAmount getPostActionSubtotal()
      The subscription item subtotal after to the action being taken, reflecting the typical recurring price for the item. If the subscription item has been removed as part of the action, then this value will be null.

      This subtotal does include the recurring discounts, however it only includes the discounts applicable to the current period. For example, if you have a discountA that is applicable from period 1-3 and a discountB that is applicable from period 4-6 (although rare), then only discountA will be included in this subtotal if you are modifying the subscription in period 2.

    • setCartItemId

      public void setCartItemId(String cartItemId)
      Reference to the subscription CartItem. If the subscription item has been removed as part of the action, then this value will be null.

    • setItemRefType

      public void setItemRefType(String itemRefType)
      Type of item that this object represents. For example, BLC_PRODUCT.

    • setItemRef

      public void setItemRef(String itemRef)
      Reference to the id of the item represented by this object. For example, the product id.

    • setItemName

      public void setItemName(String itemName)
      Name of the item identified by getItemRefType() & getItemRef().

    • setParentItemRefType

      public void setParentItemRefType(String parentItemRefType)
      Type of the parent subscription item's backing item if this is a child subscription item.

    • setParentItemRef

      public void setParentItemRef(String parentItemRef)
      Reference of the parent subscription item's backing item if this is a child subscription item.

    • setPreActionSubtotal

      public void setPreActionSubtotal(javax.money.MonetaryAmount preActionSubtotal)
      The subscription item subtotal prior to the action being taken, reflecting the typical recurring price for the item. For a DefaultSubscriptionActionFlow.CREATE action, this value will be null since there was no prior subscription.

      This subtotal does include the recurring discounts, however it only includes the discounts applicable to the current period. For example, if you have a discountA that is applicable from period 1-3 and a discountB that is applicable from period 4-6 (although rare), then only discountA will be included in this subtotal if you are modifying the subscription in period 2.

    • setPostActionSubtotal

      public void setPostActionSubtotal(javax.money.MonetaryAmount postActionSubtotal)
      The subscription item subtotal after to the action being taken, reflecting the typical recurring price for the item. If the subscription item has been removed as part of the action, then this value will be null.

      This subtotal does include the recurring discounts, however it only includes the discounts applicable to the current period. For example, if you have a discountA that is applicable from period 1-3 and a discountB that is applicable from period 4-6 (although rare), then only discountA will be included in this subtotal if you are modifying the subscription in period 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