Package com.broadleafcommerce.subscriptionoperation.domain

Interface SubscriptionReferencedItem

All Known Implementing Classes:
Product
public interface SubscriptionReferencedItem
Identifies an entity that can be referenced by a SubscriptionItem.
Author:
Nathan Moore (nathandmoore)
See Also:

  • Method Details

    • getId

      String getId()
      The ID used by the system to identify this item. Should match a SubscriptionItem.getItemRef().
      Returns:
      The ID used by the system to identify this item

    • getUpgradeOptionReferences

      @NonNull List<String> getUpgradeOptionReferences()
      List of references (usually IDs) to items that this can upgrade to.
      Returns:
      List of references (usually IDs) to items that this can upgrade to.

    • getDowngradeOptionReferences

      @NonNull List<String> getDowngradeOptionReferences()
      List of references (usually IDs) to items that this can downgrade to.
      Returns:
      List of references (usually IDs) to items that this can downgrade to.

    • getRestrictDowngradeAfterDays

      Integer getRestrictDowngradeAfterDays()
      The number of days after which a downgrade is not allowed, until the window re-opens at the next billing cycle. null means no restriction.
      Returns:
      The number of days after which a downgrade is not allowed.

    • getMaxNumberOfActiveSubscriptions

      Integer getMaxNumberOfActiveSubscriptions()
      The max number of active subscriptions that can be created for this item. null means no restriction.
      Returns:
      The max number of active subscriptions that can be created for this item.

    • getMinimumThreshold

      Integer getMinimumThreshold()
      The minimum count of this item that must be added in a cart.
      Returns:
      the minimum count of this item that must be added in a cart

    • getMaximumThreshold

      Integer getMaximumThreshold()
      The maximum count of this item that must be added in a cart.
      Returns:
      the maximum count of this item that must be added in a cart