Package org.cyclos.model.banking.vouchers

Enum VoucherTransactionNature

java.lang.Object

java.lang.Enum<VoucherTransactionNature>

org.cyclos.model.banking.vouchers.VoucherTransactionNature

All Implemented Interfaces:

Serializable, Comparable<VoucherTransactionNature>, HasMessageKey

public enum VoucherTransactionNature
extends Enum<VoucherTransactionNature>
implements HasMessageKey

Determines the nature of a voucher transaction

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHARGEBACK	The chargeback of a voucher transaction
REDEEM	A voucher redeem
TOP_UP	A voucher top-up

Method Summary

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

REDEEM

public static final VoucherTransactionNature REDEEM

A voucher redeem

TOP_UP

public static final VoucherTransactionNature TOP_UP

A voucher top-up

CHARGEBACK

public static final VoucherTransactionNature CHARGEBACK

The chargeback of a voucher transaction

Method Detail

values

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

Returns:

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

valueOf

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

getHeadingKey

public MessageKey getHeadingKey()

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey