Package com.broadleafcommerce.subscriptionoperation.domain.enums

Enum Class DefaultSubscriptionActionUnavailableReasons

java.lang.Object

java.lang.Enum<DefaultSubscriptionActionUnavailableReasons>

com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

All Implemented Interfaces:

Serializable, Comparable<DefaultSubscriptionActionUnavailableReasons>, Constable

public enum DefaultSubscriptionActionUnavailableReasons
extends Enum<DefaultSubscriptionActionUnavailableReasons>

The default reasons on why an action is unavailable for a Subscription.

Author:

Sunny Yu

See Also:

• DefaultSubscriptionActionType

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
ACTION_NOT_ALLOWED	A generic reason for something like can't change auto-renewal for subscriptions with multi-year terms.
CANCELLATION_POLICY	The subscription cannot be cancelled because its cancellation-policy does not allow so.
DOWNGRADE_WINDOW_PASSED	Downgrade is possible for this subscription, but the number of days before which a downgrade is allowed has passed.
INCORRECT_STATE	The subscription is in an incorrect state for the given action.
INSUFFICIENT_PERMISSIONS	The user doesn't have sufficient permissions to perform the action against this subscription.
NO_DOWNGRADE_AVAILABLE	There is no downgrade available for this subscription.
NO_UPGRADE_AVAILABLE	There is no upgrade available for this subscription.

Method Summary

Modifier and Type	Method	Description
String	getMessagePath()
static boolean	isActionNotAllowed(String reason)
static boolean	isDowngradeWindowPassed(String reason)
static boolean	isIncorrectState(String reason)
static boolean	isInsufficientPermissions(String reason)
static boolean	isNoDowngradeAvailable(String reason)
static boolean	isNoUpgradeAvailable(String reason)
static DefaultSubscriptionActionUnavailableReasons	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultSubscriptionActionUnavailableReasons[]	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

INSUFFICIENT_PERMISSIONS

public static final DefaultSubscriptionActionUnavailableReasons INSUFFICIENT_PERMISSIONS

The user doesn't have sufficient permissions to perform the action against this subscription.

NO_UPGRADE_AVAILABLE

public static final DefaultSubscriptionActionUnavailableReasons NO_UPGRADE_AVAILABLE

There is no upgrade available for this subscription.

NO_DOWNGRADE_AVAILABLE

public static final DefaultSubscriptionActionUnavailableReasons NO_DOWNGRADE_AVAILABLE

There is no downgrade available for this subscription.

DOWNGRADE_WINDOW_PASSED

public static final DefaultSubscriptionActionUnavailableReasons DOWNGRADE_WINDOW_PASSED

Downgrade is possible for this subscription, but the number of days before which a downgrade is allowed has passed.

ACTION_NOT_ALLOWED

public static final DefaultSubscriptionActionUnavailableReasons ACTION_NOT_ALLOWED

A generic reason for something like can't change auto-renewal for subscriptions with multi-year terms.

INCORRECT_STATE

public static final DefaultSubscriptionActionUnavailableReasons INCORRECT_STATE

The subscription is in an incorrect state for the given action.

For example, you can only DefaultSubscriptionActionType.CANCEL an active subscription.

CANCELLATION_POLICY

public static final DefaultSubscriptionActionUnavailableReasons CANCELLATION_POLICY

The subscription cannot be cancelled because its cancellation-policy does not allow so.

Method Details

values

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

getMessagePath

public String getMessagePath()

isInsufficientPermissions

public static boolean isInsufficientPermissions(String reason)

isNoUpgradeAvailable

public static boolean isNoUpgradeAvailable(String reason)

isNoDowngradeAvailable

public static boolean isNoDowngradeAvailable(String reason)

isDowngradeWindowPassed

public static boolean isDowngradeWindowPassed(String reason)

isActionNotAllowed

public static boolean isActionNotAllowed(String reason)

isIncorrectState

public static boolean isIncorrectState(String reason)