Package org.cyclos.model.system.scripts

Enum CustomWizardScriptFunction

java.lang.Object

java.lang.Enum<CustomWizardScriptFunction>

org.cyclos.model.system.scripts.CustomWizardScriptFunction

All Implemented Interfaces:

Serializable, Comparable<CustomWizardScriptFunction>, ScriptFunction, PrefixedEnum

public enum CustomWizardScriptFunction
extends Enum<CustomWizardScriptFunction>
implements ScriptFunction

Functions for custom wizards scripts

Nested Class Summary

Nested classes/interfaces inherited from interface org.cyclos.model.system.scripts.ScriptFunction

ScriptFunction.Mapping

Enum Constant Summary

Enum Constants

Enum Constant	Description
CALLBACK	Used only when a step has performed an external redirect.
DEFAULT	The final execution of the wizard
EXTERNAL_REDIRECT	Runs before performing an external redirect, returning the URL where to redirect the user to
START	Runs when starting a new execution of the wizard
TRANSITION	Runs whenever there's a transition between steps

Field Summary

Fields

Modifier and Type	Field	Description
static String	PREFIX

Method Summary

Modifier and Type	Method	Description
MessageKey	messageKey()	Returns a message key to use for this function
String	prefix()	Returns the prefix used by this class
boolean	required()	Returns whether the function is required
static CustomWizardScriptFunction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CustomWizardScriptFunction[]	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

Methods inherited from interface org.cyclos.model.system.scripts.ScriptFunction

name

Enum Constant Detail

DEFAULT

public static final CustomWizardScriptFunction DEFAULT

The final execution of the wizard

START

public static final CustomWizardScriptFunction START

Runs when starting a new execution of the wizard

TRANSITION

public static final CustomWizardScriptFunction TRANSITION

Runs whenever there's a transition between steps

EXTERNAL_REDIRECT

public static final CustomWizardScriptFunction EXTERNAL_REDIRECT

Runs before performing an external redirect, returning the URL where to redirect the user to

CALLBACK

public static final CustomWizardScriptFunction CALLBACK

Used only when a step has performed an external redirect. Is the function called when the external site redirects the user back to Cyclos

Field Detail

PREFIX

public static final String PREFIX

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

messageKey

public MessageKey messageKey()

Description copied from interface: ScriptFunction

Returns a message key to use for this function

Specified by:

messageKey in interface ScriptFunction

prefix

public String prefix()

Description copied from interface: PrefixedEnum

Returns the prefix used by this class

Specified by:

prefix in interface PrefixedEnum

required

public boolean required()

Description copied from interface: ScriptFunction

Returns whether the function is required

Specified by:

required in interface ScriptFunction