Package com.broadleafcommerce.paymenttransaction.domain.enums

Enum Class DefaultPaymentManagementAccessRestrictions

java.lang.Object

java.lang.Enum<DefaultPaymentManagementAccessRestrictions>

com.broadleafcommerce.paymenttransaction.domain.enums.DefaultPaymentManagementAccessRestrictions

All Implemented Interfaces:

PaymentManagementAccessRestrictions, Serializable, Comparable<DefaultPaymentManagementAccessRestrictions>, Constable

public enum DefaultPaymentManagementAccessRestrictions
extends Enum<DefaultPaymentManagementAccessRestrictions>
implements PaymentManagementAccessRestrictions

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
CSR_OWNED	Represents a payment which is being managed by a CSR for the customer.
CUSTOMER_MUTABILITY_BLOCKED	Represents a payment which cannot currently be mutated by the customer.
CUSTOMER_MUTABILITY_BLOCKED_FOR_PAYMENT_FINALIZATION	Represents a payment which cannot currently be mutated by the customer.
TEST_USER_OWNED	Represents a payment which is being managed by an admin in preview mode.

Method Summary

Modifier and Type	Method	Description
static boolean	isCsrOwned(String paymentManagementStatus)
static boolean	isCustomerMutabilityBlocked(String paymentManagementStatus)
static boolean	isCustomerMutabilityBlockedForPaymentFinalization(String paymentManagementStatus)
static boolean	isTest(String paymentManagementStatus)
static DefaultPaymentManagementAccessRestrictions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DefaultPaymentManagementAccessRestrictions[]	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.paymenttransaction.domain.enums.PaymentManagementAccessRestrictions

name

Enum Constant Details

CUSTOMER_MUTABILITY_BLOCKED

public static final DefaultPaymentManagementAccessRestrictions CUSTOMER_MUTABILITY_BLOCKED

Represents a payment which cannot currently be mutated by the customer. This can be set anytime the customer should not be able to update a payment (i.e. the payment for a submitted order).

CUSTOMER_MUTABILITY_BLOCKED_FOR_PAYMENT_FINALIZATION

public static final DefaultPaymentManagementAccessRestrictions CUSTOMER_MUTABILITY_BLOCKED_FOR_PAYMENT_FINALIZATION

Represents a payment which cannot currently be mutated by the customer.

This restriction is typically used if a checkout transaction has been attempted, but additional actions from the customer is required to finalize the transaction. For example, 3DS verification may be required, or a payment interaction must be completed on a gateway-hosted page. In this kind of checkout interaction, if the cart is valid and payments will sufficiently cover the cart total, then the customer only needs to finalize the payments to complete their checkout. In this scenario, the customer should not be allowed to update (e.g. modify the payment amount) or archive the Payment. On the other hand, if the customer chooses to opt-out of finalizing the payment, then this restriction can be removed, allowing the payment to be updated or archived by the customer.

CSR_OWNED

public static final DefaultPaymentManagementAccessRestrictions CSR_OWNED

Represents a payment which is being managed by a CSR for the customer. An payment in this status is not visible to the customer. This payment was either created by a CSR or cloned from an existing customer's payment, and can be transferred back to the customer.

TEST_USER_OWNED

public static final DefaultPaymentManagementAccessRestrictions TEST_USER_OWNED

Represents a payment which is being managed by an admin in preview mode. This cannot be used during checkout submission.

Method Details

values

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

isCustomerMutabilityBlocked

public static boolean isCustomerMutabilityBlocked(String paymentManagementStatus)

isCustomerMutabilityBlockedForPaymentFinalization

public static boolean isCustomerMutabilityBlockedForPaymentFinalization(String paymentManagementStatus)

isCsrOwned

public static boolean isCsrOwned(String paymentManagementStatus)

isTest

public static boolean isTest(String paymentManagementStatus)