Package org.cyclos.model.banking.voucherconfigurations

Enum VoucherGenerationStatus

java.lang.Object

java.lang.Enum<VoucherGenerationStatus>

org.cyclos.model.banking.voucherconfigurations.VoucherGenerationStatus

All Implemented Interfaces:

Serializable, Comparable<VoucherGenerationStatus>, HasMessageKey

public enum VoucherGenerationStatus
extends Enum<VoucherGenerationStatus>
implements HasMessageKey

Indicates how the amount of a voucher pack is generated

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	Vouchers are generated active, backed by a reservation in a system account.
BLOCKED	Vouchers are generated blocked, non-backed.
INACTIVE	Vouchers are generated inactive, non-backed.

Method Summary

Modifier and Type	Method	Description
VoucherStatus	generatedVoucherStatus()	Returns the initial status for generated vouchers
MessageKey	getMessageKey()
static VoucherGenerationStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static VoucherGenerationStatus[]	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

ACTIVE

public static final VoucherGenerationStatus ACTIVE

Vouchers are generated active, backed by a reservation in a system account.

BLOCKED

public static final VoucherGenerationStatus BLOCKED

Vouchers are generated blocked, non-backed. When unblocked, a reservation in a system account is done.

INACTIVE

public static final VoucherGenerationStatus INACTIVE

Vouchers are generated inactive, non-backed. When activated with a top-up, a user to system payment is done.

Method Detail

values

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

Returns:

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

valueOf

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

generatedVoucherStatus

public VoucherStatus generatedVoucherStatus()

Returns the initial status for generated vouchers

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey