VoucherCustomFieldUsage (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<VoucherCustomFieldUsage>
- - org.cyclos.model.banking.vouchers.VoucherCustomFieldUsage

All Implemented Interfaces:

Serializable, Comparable<VoucherCustomFieldUsage>, HasMessageKey
```
public enum VoucherCustomFieldUsage
extends Enum<VoucherCustomFieldUsage>
implements HasMessageKey
```
Determines the when will be used the custom field

Enum Constant Summary

Enum Constants
Enum Constant Description

ACTIVATION
When activating

CREATION
When creating

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MessageKey`	`getMessageKey()`
`static VoucherCustomFieldUsage`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static VoucherCustomFieldUsage[]`	`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
  - ACTIVATION
```
public static final VoucherCustomFieldUsage ACTIVATION
```
    When activating
  - CREATION
```
public static final VoucherCustomFieldUsage CREATION
```
    When creating
- Method Detail
  - values
```
public static VoucherCustomFieldUsage[] 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 (VoucherCustomFieldUsage c : VoucherCustomFieldUsage.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static VoucherCustomFieldUsage 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