Package com.redwood.scheduler.api.model.enumeration

Enum ModelChangeAction

java.lang.Object

java.lang.Enum<ModelChangeAction>

com.redwood.scheduler.api.model.enumeration.ModelChangeAction

All Implemented Interfaces:

BaseSchedulerEnumeration<ModelChangeAction,Character>, SchedulerEnumeration<ModelChangeAction>, Serializable, Comparable<ModelChangeAction>

public enum ModelChangeAction
extends Enum<ModelChangeAction>
implements SchedulerEnumeration<ModelChangeAction>

The type of actions that can be performed with a model change. (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Created	The object was created.
Deleted	The object was deleted.
Modified	The object was modified.
Special	A special action was performed on the object.

Field Summary

Fields

Modifier and Type	Field	Description
static char	CreatedCode	The char returned from Created.getCodeEx().
static char	DeletedCode	The char returned from Deleted.getCodeEx().
static char	ModifiedCode	The char returned from Modified.getCodeEx().
static char	SpecialCode	The char returned from Special.getCodeEx().

Method Summary

Modifier and Type	Method	Description
char	getCodeEx()	Get the code that is used to represent this enumeration in the database.
Character	getCodeExCharacter()	Get the code that is used to represent this enumeration in the database.
String	getCodeExString()	Get the code that is used to represent this enumeration in the database.
Character	getCodeExValue()	Return the code for the enumeration item as the database type of this enumeration.
String	getDescriptionKey()	Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.
String	getTranslationEN()	Get the English name of this enumeration.
String	getTranslationKey()	Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.
static ModelChangeAction	safeValueOf(String value)	Helper function to return the ModelChangeAction represented by value.
static ModelChangeAction	valueOf(char code)	Helper function to return the ModelChangeAction represented by code.
static ModelChangeAction	valueOf(Character code)	Helper function to return the ModelChangeAction represented by code.
static ModelChangeAction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ModelChangeAction	valueOfCode(String code)	Helper function to return the ModelChangeAction represented by code.
static ModelChangeAction[]	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 com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

name, ordinal

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

Created

public static final ModelChangeAction Created

The object was created.

Modified

public static final ModelChangeAction Modified

The object was modified.

Deleted

public static final ModelChangeAction Deleted

The object was deleted.

Special

public static final ModelChangeAction Special

A special action was performed on the object.

Field Detail

CreatedCode

public static final char CreatedCode

The char returned from Created.getCodeEx().

See Also:

Created, Constant Field Values

ModifiedCode

public static final char ModifiedCode

The char returned from Modified.getCodeEx().

See Also:

Modified, Constant Field Values

DeletedCode

public static final char DeletedCode

The char returned from Deleted.getCodeEx().

See Also:

Deleted, Constant Field Values

SpecialCode

public static final char SpecialCode

The char returned from Special.getCodeEx().

See Also:

Special, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

valueOfCode

public static ModelChangeAction valueOfCode(String code)

Helper function to return the ModelChangeAction represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.

Parameters:

code - A string with one character that is one of the codes for ModelChangeAction

Returns:

The ModelChangeAction corresponding to code, or null, if code is null, longer than one character, or not a valid code

safeValueOf

public static ModelChangeAction safeValueOf(String value)

Helper function to return the ModelChangeAction represented by value. If value is null, or not a valid ModelChangeAction enumeration then this method will return null.

The main difference between this method and valueOf(String), is that this method will return null when passed an invalid value, valueOf(String) will throw an IllegalArgumentException.

Parameters:

value - The string value that corresponds to the requested enumeration value

Returns:

The ModelChangeAction corresponding to value, or null, if value is null, or not a valid enumeration

See Also:

valueOf(String)

valueOf

public static ModelChangeAction valueOf(Character code)

Helper function to return the ModelChangeAction represented by code. If code is null, or not a valid ModelChangeAction code then this method will return null.

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

The ModelChangeAction corresponding to code, or null, if code is null, or not a valid code

valueOf

public static ModelChangeAction valueOf(char code)

Helper function to return the ModelChangeAction represented by code. If code is not a valid ModelChangeAction code then this method will return null.

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

The ModelChangeAction corresponding to code, or null, if code is not a valid code

getCodeEx

public char getCodeEx()

Description copied from interface: SchedulerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeEx in interface SchedulerEnumeration<ModelChangeAction>

Returns:

the database code for the enumeration

getCodeExValue

public Character getCodeExValue()

Description copied from interface: BaseSchedulerEnumeration

Return the code for the enumeration item as the database type of this enumeration.

Specified by:

getCodeExValue in interface BaseSchedulerEnumeration<ModelChangeAction,Character>

Returns:

the enumeration code

getCodeExCharacter

public Character getCodeExCharacter()

Description copied from interface: SchedulerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeExCharacter in interface SchedulerEnumeration<ModelChangeAction>

Returns:

the database code for the enumeration

getTranslationKey

public String getTranslationKey()

Description copied from interface: BaseSchedulerEnumeration

Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.

Specified by:

getTranslationKey in interface BaseSchedulerEnumeration<ModelChangeAction,Character>

Returns:

the key.

getTranslationEN

public String getTranslationEN()

Description copied from interface: BaseSchedulerEnumeration

Get the English name of this enumeration.

Specified by:

getTranslationEN in interface BaseSchedulerEnumeration<ModelChangeAction,Character>

Returns:

the English name of this enumeration.

getDescriptionKey

public String getDescriptionKey()

Description copied from interface: BaseSchedulerEnumeration

Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.

Specified by:

getDescriptionKey in interface BaseSchedulerEnumeration<ModelChangeAction,Character>

Returns:

the key that can be passed to SchedulerSession.translateField(String) to retrieve the translated description.

getCodeExString

public String getCodeExString()

Description copied from interface: SchedulerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeExString in interface SchedulerEnumeration<ModelChangeAction>

Returns:

the database code for the enumeration