Package com.broadleafcommerce.subscription.domain.enums

Enum Class DefaultShortenedPeriodReason

java.lang.Object

java.lang.Enum<DefaultShortenedPeriodReason>

com.broadleafcommerce.subscription.domain.enums.DefaultShortenedPeriodReason

All Implemented Interfaces:

Serializable, Comparable<DefaultShortenedPeriodReason>, Constable

public enum DefaultShortenedPeriodReason
extends Enum<DefaultShortenedPeriodReason>

Enum values describing the reason for a subscription's period to be shortened.

Author:

Chris Kittrell (ckittrell)

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
END_OF_TERMS	Declares that the subscription's period was shortened by reaching the Subscription.getEndOfTermDate()
SCHEDULED_STATUS_CHANGE	Declares that the subscription's period was shortened by reaching the Subscription.getNextStatusChangeDate()

Method Summary

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

END_OF_TERMS

public static final DefaultShortenedPeriodReason END_OF_TERMS

Declares that the subscription's period was shortened by reaching the Subscription.getEndOfTermDate()

SCHEDULED_STATUS_CHANGE

public static final DefaultShortenedPeriodReason SCHEDULED_STATUS_CHANGE

Declares that the subscription's period was shortened by reaching the Subscription.getNextStatusChangeDate()

Method Details

values

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

isEndOfTerms

public static boolean isEndOfTerms(String reason)

isScheduledStatusChange

public static boolean isScheduledStatusChange(String reason)