Package org.cyclos.model.banking.transferfees

Enum TransferFeePhase

java.lang.Object

java.lang.Enum<TransferFeePhase>

org.cyclos.model.banking.transferfees.TransferFeePhase

All Implemented Interfaces:

Serializable, Comparable<TransferFeePhase>

public enum TransferFeePhase
extends Enum<TransferFeePhase>

Defines the different phases during which a transfer fee calculation script can be executed.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHORIZATION	Phase for calculating the transfer fee to be included in the reserved amount when the payment is submitted for authorization.
PREVIEW	Phase for previewing the transfer fee before the actual payment is made, or whenever a pending payment is viewed.
TRANSFER	Phase for calculating the final transfer fee when the payment is actually processed.

Method Summary

Modifier and Type	Method	Description
static TransferFeePhase	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TransferFeePhase[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PREVIEW

public static final TransferFeePhase PREVIEW

Phase for previewing the transfer fee before the actual payment is made, or whenever a pending payment is viewed.

AUTHORIZATION

public static final TransferFeePhase AUTHORIZATION

Phase for calculating the transfer fee to be included in the reserved amount when the payment is submitted for authorization.

TRANSFER

public static final TransferFeePhase TRANSFER

Phase for calculating the final transfer fee when the payment is actually processed. The amount calculated in this phase will be the fee that is effectively charged.

Method Detail

values

public static TransferFeePhase[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TransferFeePhase c : TransferFeePhase.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TransferFeePhase valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null