org.cyclos.model.system.scripts

Enum LoadValuesScriptFunction

java.lang.Object

java.lang.Enum<LoadValuesScriptFunction>

org.cyclos.model.system.scripts.LoadValuesScriptFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LoadValuesScriptFunction>, ScriptFunction, PrefixedEnum

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

Functions for scripts that load custom field values

Author:

luis

Nested Class Summary

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

ScriptFunction.Mapping

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENTITY The function executed to load values when either creating or modifying an entity
FILTER The function executed to load values when the field is being used as search filter or in a bulk action.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PREFIX

Method Summary

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

ENTITY

public static final LoadValuesScriptFunction ENTITY

The function executed to load values when either creating or modifying an entity

FILTER

public static final LoadValuesScriptFunction FILTER

The function executed to load values when the field is being used as search filter or in a bulk action.

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

prefix

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