Package org.cyclos.model.banking.vouchers

Enum VoucherCreationType

java.lang.Object

java.lang.Enum<VoucherCreationType>

org.cyclos.model.banking.vouchers.VoucherCreationType

All Implemented Interfaces:

Serializable, Comparable<VoucherCreationType>, HasMessageKey

public enum VoucherCreationType
extends Enum<VoucherCreationType>
implements HasMessageKey

Determines how a voucher was created

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOUGHT	The voucher was bought by a user
GENERATED	The voucher was generated by an administrator
SENT	The voucher was bought by a user and sent to an external/internal user by e-mail

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
boolean	isBuy()	Returns if this creation type is a bought (buy or send)
boolean	isGeneration()	Returns if this creation type is a generation
static VoucherCreationType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static VoucherCreationType[]	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

GENERATED

public static final VoucherCreationType GENERATED

The voucher was generated by an administrator

BOUGHT

public static final VoucherCreationType BOUGHT

The voucher was bought by a user

SENT

public static final VoucherCreationType SENT

The voucher was bought by a user and sent to an external/internal user by e-mail

Method Detail

values

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

Returns:

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

valueOf

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

isBuy

public boolean isBuy()

Returns if this creation type is a bought (buy or send)

isGeneration

public boolean isGeneration()

Returns if this creation type is a generation