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

Enum JobDefinitionAlertSourceRuleVariable

java.lang.Object

java.lang.Enum<JobDefinitionAlertSourceRuleVariable>

com.redwood.scheduler.api.model.enumeration.JobDefinitionAlertSourceRuleVariable

All Implemented Interfaces:

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

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

A variable for use in job definition alert source rules. (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Priority	The processes priority.
ProcessServer	The processes process server.
Queue	The processes queue.
RemoteEvent	The processes remote event.
RemoteId	The processes remote id.
RemoteStatus	The processes remote status.
RemoteSystem	The processes remote system.
ReturnCode	The processes return code.

Field Summary

Fields

Modifier and Type	Field	Description
static char	PriorityCode	The char returned from Priority.getCodeEx().
static char	ProcessServerCode	The char returned from ProcessServer.getCodeEx().
static char	QueueCode	The char returned from Queue.getCodeEx().
static char	RemoteEventCode	The char returned from RemoteEvent.getCodeEx().
static char	RemoteIdCode	The char returned from RemoteId.getCodeEx().
static char	RemoteStatusCode	The char returned from RemoteStatus.getCodeEx().
static char	RemoteSystemCode	The char returned from RemoteSystem.getCodeEx().
static char	ReturnCodeCode	The char returned from ReturnCode.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 JobDefinitionAlertSourceRuleVariable	safeValueOf(String value)	Helper function to return the JobDefinitionAlertSourceRuleVariable represented by value.
static JobDefinitionAlertSourceRuleVariable	valueOf(char code)	Helper function to return the JobDefinitionAlertSourceRuleVariable represented by code.
static JobDefinitionAlertSourceRuleVariable	valueOf(Character code)	Helper function to return the JobDefinitionAlertSourceRuleVariable represented by code.
static JobDefinitionAlertSourceRuleVariable	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JobDefinitionAlertSourceRuleVariable	valueOfCode(String code)	Helper function to return the JobDefinitionAlertSourceRuleVariable represented by code.
static JobDefinitionAlertSourceRuleVariable[]	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

Queue

public static final JobDefinitionAlertSourceRuleVariable Queue

The processes queue.

ProcessServer

public static final JobDefinitionAlertSourceRuleVariable ProcessServer

The processes process server.

RemoteStatus

public static final JobDefinitionAlertSourceRuleVariable RemoteStatus

The processes remote status.

RemoteSystem

public static final JobDefinitionAlertSourceRuleVariable RemoteSystem

The processes remote system.

RemoteId

public static final JobDefinitionAlertSourceRuleVariable RemoteId

The processes remote id.

Priority

public static final JobDefinitionAlertSourceRuleVariable Priority

The processes priority.

ReturnCode

public static final JobDefinitionAlertSourceRuleVariable ReturnCode

The processes return code.

RemoteEvent

public static final JobDefinitionAlertSourceRuleVariable RemoteEvent

The processes remote event.

Field Detail

QueueCode

public static final char QueueCode

The char returned from Queue.getCodeEx().

See Also:

Queue, Constant Field Values

ProcessServerCode

public static final char ProcessServerCode

The char returned from ProcessServer.getCodeEx().

See Also:

ProcessServer, Constant Field Values

RemoteStatusCode

public static final char RemoteStatusCode

The char returned from RemoteStatus.getCodeEx().

See Also:

RemoteStatus, Constant Field Values

RemoteSystemCode

public static final char RemoteSystemCode

The char returned from RemoteSystem.getCodeEx().

See Also:

RemoteSystem, Constant Field Values

RemoteIdCode

public static final char RemoteIdCode

The char returned from RemoteId.getCodeEx().

See Also:

RemoteId, Constant Field Values

PriorityCode

public static final char PriorityCode

The char returned from Priority.getCodeEx().

See Also:

Priority, Constant Field Values

ReturnCodeCode

public static final char ReturnCodeCode

The char returned from ReturnCode.getCodeEx().

See Also:

ReturnCode, Constant Field Values

RemoteEventCode

public static final char RemoteEventCode

The char returned from RemoteEvent.getCodeEx().

See Also:

RemoteEvent, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static JobDefinitionAlertSourceRuleVariable 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 JobDefinitionAlertSourceRuleVariable valueOfCode(String code)

Helper function to return the JobDefinitionAlertSourceRuleVariable 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 JobDefinitionAlertSourceRuleVariable

Returns:

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

safeValueOf

public static JobDefinitionAlertSourceRuleVariable safeValueOf(String value)

Helper function to return the JobDefinitionAlertSourceRuleVariable represented by value. If value is null, or not a valid JobDefinitionAlertSourceRuleVariable 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 JobDefinitionAlertSourceRuleVariable corresponding to value, or null, if value is null, or not a valid enumeration

See Also:

valueOf(String)

valueOf

public static JobDefinitionAlertSourceRuleVariable valueOf(Character code)

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

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

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

valueOf

public static JobDefinitionAlertSourceRuleVariable valueOf(char code)

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

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

The JobDefinitionAlertSourceRuleVariable 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<JobDefinitionAlertSourceRuleVariable>

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<JobDefinitionAlertSourceRuleVariable,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<JobDefinitionAlertSourceRuleVariable>

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<JobDefinitionAlertSourceRuleVariable,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<JobDefinitionAlertSourceRuleVariable,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<JobDefinitionAlertSourceRuleVariable,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<JobDefinitionAlertSourceRuleVariable>

Returns:

the database code for the enumeration