Package org.cyclos.model.system.scripts

Enum CustomOperationScriptFunction

java.lang.Object

java.lang.Enum<CustomOperationScriptFunction>

org.cyclos.model.system.scripts.CustomOperationScriptFunction

All Implemented Interfaces:

Serializable, Comparable<CustomOperationScriptFunction>, ScriptFunction, PrefixedEnum

public enum CustomOperationScriptFunction
extends Enum<CustomOperationScriptFunction>
implements ScriptFunction

Functions for custom operation 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
AVAILABILITY	Runs before the custom operation is presented as an option to users, to determine whether the operation is available.
CALLBACK	Used only when the custom operation result type is CustomOperationResultType.EXTERNAL_REDIRECT.
DEFAULT	The default custom operation execution
PRE_RUN	Runs before executing the custom operation, in order to determine the default field values

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 CustomOperationScriptFunction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CustomOperationScriptFunction[]	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 CustomOperationScriptFunction DEFAULT

The default custom operation execution

PRE_RUN

public static final CustomOperationScriptFunction PRE_RUN

Runs before executing the custom operation, in order to determine the default field values

AVAILABILITY

public static final CustomOperationScriptFunction AVAILABILITY

Runs before the custom operation is presented as an option to users, to determine whether the operation is available. For example, a user operation may be only available for users with a specific custom field value.

CALLBACK

public static final CustomOperationScriptFunction CALLBACK

Used only when the custom operation result type is CustomOperationResultType.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 CustomOperationScriptFunction[] 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 (CustomOperationScriptFunction c : CustomOperationScriptFunction.values())
    System.out.println(c);

Returns:

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

valueOf

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