Package org.cyclos.model.banking.accountfees

Enum AccountFeeBalanceHandling

java.lang.Object

java.lang.Enum<AccountFeeBalanceHandling>

org.cyclos.model.banking.accountfees.AccountFeeBalanceHandling

All Implemented Interfaces:

Serializable, Comparable<AccountFeeBalanceHandling>, HasMessageKey

public enum AccountFeeBalanceHandling
extends Enum<AccountFeeBalanceHandling>
implements HasMessageKey

Determines how an account fee handles the balance of affected accounts

Enum Constant Summary

Enum Constants

Enum Constant	Description
FAIL_WHEN_NO_LIMIT	Don't reserve any amount and don't allow accounts to go negative, making charges fail
FORCE_CHARGE	Don't reserve any amount, allowing accounts to go negative when charging
RESERVE	Reserve the amount, never allowing accounts to go negative

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
static AccountFeeBalanceHandling	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AccountFeeBalanceHandling[]	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

FAIL_WHEN_NO_LIMIT

public static final AccountFeeBalanceHandling FAIL_WHEN_NO_LIMIT

Don't reserve any amount and don't allow accounts to go negative, making charges fail

RESERVE

public static final AccountFeeBalanceHandling RESERVE

Reserve the amount, never allowing accounts to go negative

FORCE_CHARGE

public static final AccountFeeBalanceHandling FORCE_CHARGE

Don't reserve any amount, allowing accounts to go negative when charging

Method Detail

values

public static AccountFeeBalanceHandling[] 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 (AccountFeeBalanceHandling c : AccountFeeBalanceHandling.values())
    System.out.println(c);

Returns:

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

valueOf

public static AccountFeeBalanceHandling 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

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey