Package com.broadleafcommerce.catalog.domain.commerce

Enum Class EndOfTermStrategy

java.lang.Object

java.lang.Enum<EndOfTermStrategy>

com.broadleafcommerce.catalog.domain.commerce.EndOfTermStrategy

All Implemented Interfaces:

Serializable, Comparable<EndOfTermStrategy>, Constable

public enum EndOfTermStrategy
extends Enum<EndOfTermStrategy>

The strategies by which a subscription's end of term can be configured.

Since:

Catalog Services 2.3.0, Release Train 2.3.0

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
AUTO_RENEW	Declares that the subscription's terms will be renewed
CANCEL	Declares that the subscription will be cancelled

Method Summary

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

AUTO_RENEW

public static final EndOfTermStrategy AUTO_RENEW

Declares that the subscription's terms will be renewed

CANCEL

public static final EndOfTermStrategy CANCEL

Declares that the subscription will be cancelled

Method Details

values

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

isCancel

public static boolean isCancel(String strategy)

isAutoRenew

public static boolean isAutoRenew(String strategy)