Package com.broadleafcommerce.paymentgateway.domain.enums

Enum Class DefaultTransactionIdentifierTypes

java.lang.Object

java.lang.Enum<DefaultTransactionIdentifierTypes>

com.broadleafcommerce.paymentgateway.domain.enums.DefaultTransactionIdentifierTypes

All Implemented Interfaces:

TransactionIdentifierType, Serializable, Comparable<DefaultTransactionIdentifierTypes>, Constable

public enum DefaultTransactionIdentifierTypes
extends Enum<DefaultTransactionIdentifierTypes>
implements TransactionIdentifierType

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
GATEWAY_TRANSACTION_ID	The transaction identifier returned from the gateway.
TRANSACTION_REFERENCE_ID	The transaction identifier communicated via PaymentRequest.getTransactionReferenceId() and PaymentResponse.getTransactionReferenceId().

Method Summary

Modifier and Type	Method	Description
static boolean	isGatewayTransactionId(String transactionIdentifierType)
static boolean	isTransactionReferenceId(String transactionIdentifierType)
static DefaultTransactionIdentifierTypes	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultTransactionIdentifierTypes[]	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.paymentgateway.domain.enums.TransactionIdentifierType

name

Enum Constant Details

TRANSACTION_REFERENCE_ID

public static final DefaultTransactionIdentifierTypes TRANSACTION_REFERENCE_ID

The transaction identifier communicated via PaymentRequest.getTransactionReferenceId() and PaymentResponse.getTransactionReferenceId().

GATEWAY_TRANSACTION_ID

public static final DefaultTransactionIdentifierTypes GATEWAY_TRANSACTION_ID

The transaction identifier returned from the gateway.

Method Details

values

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

isTransactionReferenceId

public static boolean isTransactionReferenceId(String transactionIdentifierType)

isGatewayTransactionId

public static boolean isGatewayTransactionId(String transactionIdentifierType)