org.cyclos.model.system.extensionpoints

Enum VoucherExtensionPointEvent

java.lang.Object

java.lang.Enum<VoucherExtensionPointEvent>

org.cyclos.model.system.extensionpoints.VoucherExtensionPointEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<VoucherExtensionPointEvent>, ExtensionPointEvent

public enum VoucherExtensionPointEvent
extends java.lang.Enum<VoucherExtensionPointEvent>
implements ExtensionPointEvent

Possible events to be handled by voucher extension points

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUY A voucher is being bought by an user
CANCEL A generated voucher is being canceled
EXPIRE A voucher is being expired
GENERATE A voucher is being generated
REDEEM A voucher is being redeemed

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_VOUCHER Scripting attribute: the user voucher affected

Method Summary

Modifier and Type	Method and Description
ExtensionPointNature	nature() Returns the nature of this set of events
static VoucherExtensionPointEvent	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static VoucherExtensionPointEvent[]	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

Methods inherited from interface org.cyclos.model.system.extensionpoints.ExtensionPointEvent

name

Enum Constant Detail

GENERATE

public static final VoucherExtensionPointEvent GENERATE

A voucher is being generated

BUY

public static final VoucherExtensionPointEvent BUY

A voucher is being bought by an user

REDEEM

public static final VoucherExtensionPointEvent REDEEM

A voucher is being redeemed

CANCEL

public static final VoucherExtensionPointEvent CANCEL

A generated voucher is being canceled

EXPIRE

public static final VoucherExtensionPointEvent EXPIRE

A voucher is being expired

Field Detail

ATTR_VOUCHER

public static final java.lang.String ATTR_VOUCHER

Scripting attribute: the user voucher affected

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static VoucherExtensionPointEvent valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

nature

public ExtensionPointNature nature()

Description copied from interface: ExtensionPointEvent

Returns the nature of this set of events

Specified by:

nature in interface ExtensionPointEvent