Package org.cyclos.model.users.users

Enum UserStatus

java.lang.Object

java.lang.Enum<UserStatus>

org.cyclos.model.users.users.UserStatus

All Implemented Interfaces:

Serializable, Comparable<UserStatus>, HasMessageKey

public enum UserStatus
extends Enum<UserStatus>
implements HasMessageKey

Represents the states of a user

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	The user is a full member
BLOCKED	The user access is blocked - he cannot access any channel, but is still visible by others
DISABLED	The user is disabled - he cannot access any channel and no other user can see him
PENDING	The user is pending e-mail validation
PURGED	The user is permanently removed and had the personal data erased
REMOVED	The user is permanently removed

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
boolean	isRemoved()	Returns whether this status is either REMOVED or PURGED
static EnumMessageKeyResolver<UserStatus>	resolverForChangeStatus()
static UserStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UserStatus[]	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

PENDING

public static final UserStatus PENDING

The user is pending e-mail validation

ACTIVE

public static final UserStatus ACTIVE

The user is a full member

BLOCKED

public static final UserStatus BLOCKED

The user access is blocked - he cannot access any channel, but is still visible by others

DISABLED

public static final UserStatus DISABLED

The user is disabled - he cannot access any channel and no other user can see him

REMOVED

public static final UserStatus REMOVED

The user is permanently removed

PURGED

public static final UserStatus PURGED

The user is permanently removed and had the personal data erased

Method Detail

values

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

Returns:

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

valueOf

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

resolverForChangeStatus

public static EnumMessageKeyResolver<UserStatus> resolverForChangeStatus()

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey

isRemoved

public boolean isRemoved()

Returns whether this status is either REMOVED or PURGED