Package com.broadleafcommerce.subscriptionoperation.service

Class SubscriptionOperationServiceProperties

java.lang.Object
com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties
@ConfigurationProperties("broadleaf.subscriptionoperation.service") public class SubscriptionOperationServiceProperties extends Object
Configurable properties for the Subscription Operation Service.

  • Constructor Details

    • SubscriptionOperationServiceProperties

      public SubscriptionOperationServiceProperties()

  • Method Details

    • getAllowedActionsBySubscriptionStatus

      public List<String> getAllowedActionsBySubscriptionStatus(String subscriptionStatus)

    • getFormerSubscriptionStatuses

      public List<String> getFormerSubscriptionStatuses()
      List of subscription statuses that are considered as former subscription statuses.

    • getActiveSubscriptionStatuses

      public List<String> getActiveSubscriptionStatuses()
      List of subscription statuses that are considered as active subscription statuses.

    • getAllowedActionsBySubscriptionStatus

      public Map<String,List<String>> getAllowedActionsBySubscriptionStatus()
      List of allowed subscription actions for each subscription status.

      Note that these allowed actions are purely based on status, the actions may be further restricted by business logic, e.g. DefaultSubscriptionActionType.UPGRADE is not available if the subscription doesn't have any upgrade options.

    • getSubscriptionWithItemsPageSize

      public int getSubscriptionWithItemsPageSize()
      the default page size for gathering SubscriptionWithItems from BillingServices

    • setFormerSubscriptionStatuses

      public void setFormerSubscriptionStatuses(List<String> formerSubscriptionStatuses)
      List of subscription statuses that are considered as former subscription statuses.

    • setActiveSubscriptionStatuses

      public void setActiveSubscriptionStatuses(List<String> activeSubscriptionStatuses)
      List of subscription statuses that are considered as active subscription statuses.

    • setAllowedActionsBySubscriptionStatus

      public void setAllowedActionsBySubscriptionStatus(Map<String,List<String>> allowedActionsBySubscriptionStatus)
      List of allowed subscription actions for each subscription status.

      Note that these allowed actions are purely based on status, the actions may be further restricted by business logic, e.g. DefaultSubscriptionActionType.UPGRADE is not available if the subscription doesn't have any upgrade options.

    • setSubscriptionWithItemsPageSize

      public void setSubscriptionWithItemsPageSize(int subscriptionWithItemsPageSize)
      the default page size for gathering SubscriptionWithItems from BillingServices