org.cyclos.model.system.scripts

Enum CustomOperationScriptFunction

java.lang.Object

java.lang.Enum<CustomOperationScriptFunction>

org.cyclos.model.system.scripts.CustomOperationScriptFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CustomOperationScriptFunction>, ScriptFunction

public enum CustomOperationScriptFunction
extends java.lang.Enum<CustomOperationScriptFunction>
implements ScriptFunction

Functions for custom operation scripts

Author:

luis

Enum Constant Summary

Enum Constants

Enum Constant and Description
CALLBACK Used only when the custom operation result type is CustomOperationResultType.EXTERNAL_REDIRECT.
DEFAULT The default custom operation execution

Method Summary

Methods

Modifier and Type	Method and Description
MessageKey	messageKey() Returns a message key to use for this function
boolean	required() Returns whether the function is required
static CustomOperationScriptFunction	valueOf(java.lang.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

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

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(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.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

required

public boolean required()

Description copied from interface: ScriptFunction

Returns whether the function is required

Specified by:

required in interface ScriptFunction