Package com.broadleafcommerce.subscription.domain.enums

Enum Class DefaultCancellationChargeStrategy

java.lang.Object

java.lang.Enum<DefaultCancellationChargeStrategy>

com.broadleafcommerce.subscription.domain.enums.DefaultCancellationChargeStrategy

All Implemented Interfaces:

Serializable, Comparable<DefaultCancellationChargeStrategy>, Constable

public enum DefaultCancellationChargeStrategy
extends Enum<DefaultCancellationChargeStrategy>

The strategy for charging a cancellation fee when a customer cancels a subscription.

Author:

karanjariwala

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
NO_CHARGE	No charge to the customer.
PRORATED	Customer is charged for portion of the billing period that they have had access to the subscription.

Method Summary

Modifier and Type	Method	Description
static boolean	isNoCharge(String chargeStrategy)
static boolean	isProrated(String chargeStrategy)
static DefaultCancellationChargeStrategy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultCancellationChargeStrategy[]	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

NO_CHARGE

public static final DefaultCancellationChargeStrategy NO_CHARGE

No charge to the customer.

PRORATED

public static final DefaultCancellationChargeStrategy PRORATED

Customer is charged for portion of the billing period that they have had access to the subscription.

Method Details

values

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

isNoCharge

public static boolean isNoCharge(String chargeStrategy)

isProrated

public static boolean isProrated(String chargeStrategy)