Package com.broadleafcommerce.subscription.domain.enums

Enum Class DefaultSubscriptionSourceType

java.lang.Object

java.lang.Enum<DefaultSubscriptionSourceType>

com.broadleafcommerce.subscription.domain.enums.DefaultSubscriptionSourceType

All Implemented Interfaces:

Serializable, Comparable<DefaultSubscriptionSourceType>, Constable

public enum DefaultSubscriptionSourceType
extends Enum<DefaultSubscriptionSourceType>

Enumerates the types of subscription sources. Used in Subscription.getSubscriptionSource() and other fields.

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
BLC_ORDER	Indicates that the subscription source for a subscription is a Broadleaf Order.
BLC_ORDER_ITEM	Indicates that the subscription source for a subscription is a Broadleaf Order.
REDEMPTION_CODE	Indicates that the subscription source for a subscription is a redemption code.

Method Summary

Modifier and Type	Method	Description
static boolean	isBroadleafOrder(String sourceType)
static boolean	isBroadleafOrderItem(String sourceType)
static boolean	isRedemptionCode(String sourceType)
static DefaultSubscriptionSourceType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultSubscriptionSourceType[]	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

BLC_ORDER

public static final DefaultSubscriptionSourceType BLC_ORDER

Indicates that the subscription source for a subscription is a Broadleaf Order. Default out-of-box value.

BLC_ORDER_ITEM

public static final DefaultSubscriptionSourceType BLC_ORDER_ITEM

Indicates that the subscription source for a subscription is a Broadleaf Order.

REDEMPTION_CODE

public static final DefaultSubscriptionSourceType REDEMPTION_CODE

Indicates that the subscription source for a subscription is a redemption code.

Method Details

values

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

isBroadleafOrder

public static boolean isBroadleafOrder(String sourceType)

isBroadleafOrderItem

public static boolean isBroadleafOrderItem(String sourceType)

isRedemptionCode

public static boolean isRedemptionCode(String sourceType)