Package org.cyclos.model.users.bulkactions

Enum BulkActionUserStatus

java.lang.Object

java.lang.Enum<BulkActionUserStatus>

org.cyclos.model.users.bulkactions.BulkActionUserStatus

All Implemented Interfaces:

Serializable, Comparable<BulkActionUserStatus>, HasMessageKey

public enum BulkActionUserStatus
extends Enum<BulkActionUserStatus>
implements HasMessageKey

The status of the bulk action over a specific user

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELED	The bulk action was canceled while this user was still pending
ERROR	There was an error when processing this user
PENDING	The action has still not processed this user
SKIPPED	This user was skipped as the action didn't apply to this user (for example, changing the value of a custom field not enabled for this user)
SUCCESS	The action has successfully processed this user

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
static EnumMessageKeyResolver<BulkActionUserStatus>	resolverForAffectedUsers()	Returns an EnumMessageKeyResolver for messages of affected users with each status
static BulkActionUserStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BulkActionUserStatus[]	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

SUCCESS

public static final BulkActionUserStatus SUCCESS

The action has successfully processed this user

SKIPPED

public static final BulkActionUserStatus SKIPPED

This user was skipped as the action didn't apply to this user (for example, changing the value of a custom field not enabled for this user)

ERROR

public static final BulkActionUserStatus ERROR

There was an error when processing this user

PENDING

public static final BulkActionUserStatus PENDING

The action has still not processed this user

CANCELED

public static final BulkActionUserStatus CANCELED

The bulk action was canceled while this user was still pending

Method Detail

values

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

Returns:

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

valueOf

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

resolverForAffectedUsers

public static EnumMessageKeyResolver<BulkActionUserStatus> resolverForAffectedUsers()

Returns an EnumMessageKeyResolver for messages of affected users with each status

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey