Package org.cyclos.model.system.wizards

Enum CustomWizardNature

java.lang.Object

java.lang.Enum<CustomWizardNature>

org.cyclos.model.system.wizards.CustomWizardNature

All Implemented Interfaces:

Serializable, Comparable<CustomWizardNature>, HasMessageKey

public enum CustomWizardNature
extends Enum<CustomWizardNature>
implements HasMessageKey

Types of usages for custom wizards

Enum Constant Summary

Enum Constants

Enum Constant	Description
MENU	Wizards that can be executed through a menu item.
REGISTRATION	Specific wizard for public user registration.
SYSTEM	Only can be run by administrators.
USER	Intended to run the wizard over a user.

Method Summary

Modifier and Type	Method	Description
MessageKey	getMessageKey()
boolean	isRelatedToMenu()
static CustomWizardNature	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CustomWizardNature[]	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

REGISTRATION

public static final CustomWizardNature REGISTRATION

Specific wizard for public user registration. It must runs as guest.

USER

public static final CustomWizardNature USER

Intended to run the wizard over a user. It can be executed by the user itself or managers.

SYSTEM

public static final CustomWizardNature SYSTEM

Only can be run by administrators.

MENU

public static final CustomWizardNature MENU

Wizards that can be executed through a menu item. It can be run by guests or logged users.

Method Detail

values

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

Returns:

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

valueOf

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

isRelatedToMenu

public boolean isRelatedToMenu()