Package com.broadleafcommerce.creditaccount.domain.enums

Enum Class DefaultSourceEntityType

java.lang.Object

java.lang.Enum<DefaultSourceEntityType>

com.broadleafcommerce.creditaccount.domain.enums.DefaultSourceEntityType

All Implemented Interfaces:

SourceEntityType, Serializable, Comparable<DefaultSourceEntityType>, Constable

public enum DefaultSourceEntityType
extends Enum<DefaultSourceEntityType>
implements SourceEntityType

The default source entity types for the credit account transactions.

Author:

Dima Myroniuk (dmyroniuk)

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_APPEASEMENT	Declares that the credit account Transaction was executed due to a Broadleaf appeasement.
BLC_CREATE_CREDIT_ACCOUNT	Declares that the credit account Transaction was executed due to the creation of the credit account.
BLC_PAYMENT	Declares that the credit account Transaction was executed due to a Broadleaf payment.
BLC_RETURN	Declares that the credit account Transaction was executed due to a Broadleaf return.
CREDIT_EXPIRATION_JOB	Declares that the credit account debit Transaction was executed due to the credit expiration job.
DEBIT_TRANSACTION	Declares that the credit account debit Transaction was executed due to a debit transaction.

Method Summary

Modifier and Type	Method	Description
static boolean	isBroadleafAppeasement(String sourceEntityType)
static boolean	isBroadleafPayment(String sourceEntityType)
static boolean	isBroadleafReturn(String sourceEntityType)
static boolean	isCreditExpirationJob(String sourceEntityType)
static boolean	isDebitTransaction(String sourceEntityType)
static DefaultSourceEntityType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultSourceEntityType[]	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

Methods inherited from interface com.broadleafcommerce.creditaccount.domain.enums.SourceEntityType

name

Enum Constant Details

BLC_PAYMENT

public static final DefaultSourceEntityType BLC_PAYMENT

Declares that the credit account Transaction was executed due to a Broadleaf payment.

BLC_APPEASEMENT

public static final DefaultSourceEntityType BLC_APPEASEMENT

Declares that the credit account Transaction was executed due to a Broadleaf appeasement.

BLC_RETURN

public static final DefaultSourceEntityType BLC_RETURN

Declares that the credit account Transaction was executed due to a Broadleaf return.

BLC_CREATE_CREDIT_ACCOUNT

public static final DefaultSourceEntityType BLC_CREATE_CREDIT_ACCOUNT

Declares that the credit account Transaction was executed due to the creation of the credit account.

DEBIT_TRANSACTION

public static final DefaultSourceEntityType DEBIT_TRANSACTION

Declares that the credit account debit Transaction was executed due to a debit transaction. This is specifically used with expiring credit transactions that are expired when a debit transaction is executed.

CREDIT_EXPIRATION_JOB

public static final DefaultSourceEntityType CREDIT_EXPIRATION_JOB

Declares that the credit account debit Transaction was executed due to the credit expiration job.

See Also:

• CreditExpirationJobListener

Method Details

values

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

isBroadleafPayment

public static boolean isBroadleafPayment(String sourceEntityType)

isBroadleafAppeasement

public static boolean isBroadleafAppeasement(String sourceEntityType)

isBroadleafReturn

public static boolean isBroadleafReturn(String sourceEntityType)

isDebitTransaction

public static boolean isDebitTransaction(String sourceEntityType)

isCreditExpirationJob

public static boolean isCreditExpirationJob(String sourceEntityType)