cz.ues.platform.security.identity.dto

Enum AccountState

java.lang.Object

java.lang.Enum<AccountState>

cz.ues.platform.security.identity.dto.AccountState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AccountState>

public enum AccountState
extends java.lang.Enum<AccountState>

Enumeration that represents account states.

Since:

UES6-10

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE Account is active and can be used for authentication.
BLOCKED Account was blocked (usualy because of user ban).
INITIAL Account is created and waiting for activation.
LOCKED Account is locked (usually because of too many authentication retries).
UNDEFINED Account state is undefined.
UNKNOWN Unknown account state.

Field Summary

Fields

Modifier and Type	Field and Description
private int	value State value.

Method Summary

Methods

Modifier and Type	Method and Description
static AccountState	getEnumItem(int value) Returns account state enumeration item.
int	value() Returns account state.
static AccountState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AccountState[]	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

UNDEFINED

public static final AccountState UNDEFINED

Account state is undefined. (state not set on DTO or entity)

INITIAL

public static final AccountState INITIAL

Account is created and waiting for activation.

ACTIVE

public static final AccountState ACTIVE

Account is active and can be used for authentication.

LOCKED

public static final AccountState LOCKED

Account is locked (usually because of too many authentication retries).

BLOCKED

public static final AccountState BLOCKED

Account was blocked (usualy because of user ban).

UNKNOWN

public static final AccountState UNKNOWN

Unknown account state.

Field Detail

value

private final value

State value.

Method Detail

values

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

Returns:

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

valueOf

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

value

public int value()

Returns account state.

Returns:

Account state

getEnumItem

public static AccountState getEnumItem(int value)

Returns account state enumeration item.

Parameters:

value - Item value

Returns:

Account state