BalanceLevel (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- java.lang.Enum<BalanceLevel>
- - org.cyclos.model.banking.accounts.BalanceLevel

All Implemented Interfaces:

Serializable, Comparable<BalanceLevel>
```
public enum BalanceLevel
extends Enum<BalanceLevel>
```
Possible levels for a user account balance

Enum Constant Summary

Enum Constants
Enum Constant Description

HIGH

LOW

MEDIUM

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static BalanceLevel`	`getFromYellowRange(BigDecimal balance, IIntegerRange range)`	Returns the balance level for the given balance and range
`static BalanceLevel`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static BalanceLevel[]`	`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
  - LOW
```
public static final BalanceLevel LOW
```
  - MEDIUM
```
public static final BalanceLevel MEDIUM
```
  - HIGH
```
public static final BalanceLevel HIGH
```
- Method Detail
  - values
```
public static BalanceLevel[] 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 (BalanceLevel c : BalanceLevel.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BalanceLevel 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
  - getFromYellowRange
```
public static BalanceLevel getFromYellowRange(BigDecimal balance,
                                              IIntegerRange range)
```
    Returns the balance level for the given balance and range