Package com.broadleafcommerce.subscriptionoperation.domain.enums

Enum Class DefaultSubscriptionActionType

java.lang.Object

java.lang.Enum<DefaultSubscriptionActionType>

com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

All Implemented Interfaces:

Serializable, Comparable<DefaultSubscriptionActionType>, Constable

public enum DefaultSubscriptionActionType
extends Enum<DefaultSubscriptionActionType>

The default types of actions that can be taken against a Subscription by the user.

Author:

Sunny Yu

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCEL	A customer-driven request to cancel the subscription
CHANGE_AUTO_RENEWAL	A request to opt-into or out of auto-renewal for the subscription.
DOWNGRADE	A request to downgrade the subscription's level of service
EDIT	A request to edit the subscription's configuration
UPGRADE	A request to upgrade the subscription's level of service

Method Summary

Modifier and Type	Method	Description
static boolean	isCancel(String type)
static boolean	isChangeAutoRenewal(String type)
static boolean	isDowngrade(String type)
static boolean	isEdit(String type)
static boolean	isUpgrade(String type)
static DefaultSubscriptionActionType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultSubscriptionActionType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EDIT

public static final DefaultSubscriptionActionType EDIT

A request to edit the subscription's configuration

UPGRADE

public static final DefaultSubscriptionActionType UPGRADE

A request to upgrade the subscription's level of service

DOWNGRADE

public static final DefaultSubscriptionActionType DOWNGRADE

A request to downgrade the subscription's level of service

CANCEL

public static final DefaultSubscriptionActionType CANCEL

A customer-driven request to cancel the subscription

CHANGE_AUTO_RENEWAL

public static final DefaultSubscriptionActionType CHANGE_AUTO_RENEWAL

A request to opt-into or out of auto-renewal for the subscription. If the subscription has terms (i.e. has a contract), then changing the auto-renewal intention refers to automatically renewing the terms/contract. If the subscription does not have terms, then changing the auto-renewal intention refers to automatically renewing at the end of the subscription's current period.

Method Details

values

public static DefaultSubscriptionActionType[] 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 DefaultSubscriptionActionType 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

isEdit

public static boolean isEdit(String type)

isUpgrade

public static boolean isUpgrade(String type)

isDowngrade

public static boolean isDowngrade(String type)

isCancel

public static boolean isCancel(String type)

isChangeAutoRenewal

public static boolean isChangeAutoRenewal(String type)