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

Enum InterceptAction

java.lang.Object

java.lang.Enum<InterceptAction>

com.redwood.scheduler.api.model.enumeration.InterceptAction

All Implemented Interfaces:

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

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

Action to take with intercepted SAP jobs. (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Hold	Hold (intercept) the job in SAP; submit it on hold in the scheduler.
Ignore	Ignore process.
Monitor	Monitor (synchronize with) process.
Schedule	Hold (intercept) job in SAP; submit it in the scheduler.
ScheduleIntercepted	Schedule the job after it has been intercepted in SAP.
StartImmediately	Start an intercepted or scheduled without start date/time process immediately.

Field Summary

Fields

Modifier and Type	Field	Description
static char	HoldCode	The char returned from Hold.getCodeEx().
static char	IgnoreCode	The char returned from Ignore.getCodeEx().
static char	MonitorCode	The char returned from Monitor.getCodeEx().
static char	ScheduleCode	The char returned from Schedule.getCodeEx().
static char	ScheduleInterceptedCode	The char returned from ScheduleIntercepted.getCodeEx().
static char	StartImmediatelyCode	The char returned from StartImmediately.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 InterceptAction	safeValueOf(String value)	Helper function to return the InterceptAction represented by value.
static InterceptAction	valueOf(char code)	Helper function to return the InterceptAction represented by code.
static InterceptAction	valueOf(Character code)	Helper function to return the InterceptAction represented by code.
static InterceptAction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static InterceptAction	valueOfCode(String code)	Helper function to return the InterceptAction represented by code.
static InterceptAction[]	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

Monitor

public static final InterceptAction Monitor

Monitor (synchronize with) process.

Hold

public static final InterceptAction Hold

Hold (intercept) the job in SAP; submit it on hold in the scheduler.

Ignore

public static final InterceptAction Ignore

Ignore process.

Schedule

public static final InterceptAction Schedule

Hold (intercept) job in SAP; submit it in the scheduler.

StartImmediately

public static final InterceptAction StartImmediately

Start an intercepted or scheduled without start date/time process immediately.

ScheduleIntercepted

public static final InterceptAction ScheduleIntercepted

Schedule the job after it has been intercepted in SAP.

Field Detail

MonitorCode

public static final char MonitorCode

The char returned from Monitor.getCodeEx().

See Also:

Monitor, Constant Field Values

HoldCode

public static final char HoldCode

The char returned from Hold.getCodeEx().

See Also:

Hold, Constant Field Values

IgnoreCode

public static final char IgnoreCode

The char returned from Ignore.getCodeEx().

See Also:

Ignore, Constant Field Values

ScheduleCode

public static final char ScheduleCode

The char returned from Schedule.getCodeEx().

See Also:

Schedule, Constant Field Values

StartImmediatelyCode

public static final char StartImmediatelyCode

The char returned from StartImmediately.getCodeEx().

See Also:

StartImmediately, Constant Field Values

ScheduleInterceptedCode

public static final char ScheduleInterceptedCode

The char returned from ScheduleIntercepted.getCodeEx().

See Also:

ScheduleIntercepted, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

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

safeValueOf

public static InterceptAction safeValueOf(String value)

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

See Also:

valueOf(String)

valueOf

public static InterceptAction valueOf(Character code)

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

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

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

valueOf

public static InterceptAction valueOf(char code)

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

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

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

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

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

Returns:

the database code for the enumeration