Package org.cyclos.model.banking.voucherconfigurations

Enum VoucherPinUsage

java.lang.Object

java.lang.Enum<VoucherPinUsage>

org.cyclos.model.banking.voucherconfigurations.VoucherPinUsage

All Implemented Interfaces:

Serializable, Comparable<VoucherPinUsage>, HasMessageKey

public enum VoucherPinUsage
extends Enum<VoucherPinUsage>
implements HasMessageKey

Defines when a PIN is required for a voucher

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	A PIN is always used on voucher redeems
INFO	A PIN is used only for in the /voucher page (including unblock)
NEVER	A PIN is never used on voucher redeems
SUBSEQUENT	A PIN is not used on the first, only on subsequent redeems.

Method Summary

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

NEVER

public static final VoucherPinUsage NEVER

A PIN is never used on voucher redeems

INFO

public static final VoucherPinUsage INFO

A PIN is used only for in the /voucher page (including unblock)

SUBSEQUENT

public static final VoucherPinUsage SUBSEQUENT

A PIN is not used on the first, only on subsequent redeems. This means that for the first redeem, if the redeem amount is the full amount, a PIN will never be used. It will only be used for partial redeems. If the voucher type does not allow partial redeems, behaves as NEVER.

ALWAYS

public static final VoucherPinUsage ALWAYS

A PIN is always used on voucher redeems

Method Detail

values

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

Returns:

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

valueOf

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

isEnabled

public boolean isEnabled()