Package com.broadleafcommerce.orderoperation.domain.subscription.enums

Enum Class SubscriptionStatuses

java.lang.Object
java.lang.Enum<SubscriptionStatuses>
com.broadleafcommerce.orderoperation.domain.subscription.enums.SubscriptionStatuses
All Implemented Interfaces:
Serializable, Comparable<SubscriptionStatuses>, Constable
public enum SubscriptionStatuses extends Enum<SubscriptionStatuses>
Enumerates the statuses for a subscription.
Since:
Order Operation Service 2.2.0, Release Train 2.3.0

  • Enum Constant Details

    • PENDING_FULFILLMENT

      public static final SubscriptionStatuses PENDING_FULFILLMENT
      Indicates that the subscription is pending fulfillment.

    • FULFILLMENT_IN_PROCESS

      public static final SubscriptionStatuses FULFILLMENT_IN_PROCESS
      Indicates that the subscription sign-up or modification is being fulfilled. This is relevant for both the initial creation of the subscription & processing any subsequent edit, upgrade/downgrade, cancellation, etc. requests.

    • ACTIVE

      public static final SubscriptionStatuses ACTIVE
      Indicates an active subscription

    • CANCELLED

      public static final SubscriptionStatuses CANCELLED
      Indicates a subscription that has been cancelled

    • PENDING_CANCELLATION

      public static final SubscriptionStatuses PENDING_CANCELLATION
      Indicates a subscription that should be cancelled soon

    • PAUSED

      public static final SubscriptionStatuses PAUSED
      Indicates a subscription whose activity is temporarily halted

    • ERROR

      public static final SubscriptionStatuses ERROR
      Indicates a subscription with an error state

  • Method Details

    • values

      public static SubscriptionStatuses[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static SubscriptionStatuses valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isPendingFulfillment

      public static boolean isPendingFulfillment(String subscriptionStatus)

    • isFulfillmentInProcess

      public static boolean isFulfillmentInProcess(String subscriptionStatus)

    • isActive

      public static boolean isActive(String subscriptionStatus)

    • isCancelled

      public static boolean isCancelled(String subscriptionStatus)

    • isPendingCancellation

      public static boolean isPendingCancellation(String subscriptionStatus)

    • isPaused

      public static boolean isPaused(String subscriptionStatus)

    • isError

      public static boolean isError(String subscriptionStatus)