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

Enum ReportColumnFormat

java.lang.Object

java.lang.Enum<ReportColumnFormat>

com.redwood.scheduler.api.model.enumeration.ReportColumnFormat

All Implemented Interfaces:

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

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

The style of a ProcessServer check. (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
BusinessKey	Display the business key, if applicable, otherwise the formatted value
Formatted	Displays a formated value depending on the object type
Permalink	Display a permalink to the object, if applicable, otherwise the formatted value
PermalinkBusinessKey	Display a permalink with the business key at the link test
Raw	Displays the raw value from the database

Field Summary

Fields

Modifier and Type	Field	Description
static char	BusinessKeyCode	The char returned from BusinessKey.getCodeEx().
static char	FormattedCode	The char returned from Formatted.getCodeEx().
static char	PermalinkBusinessKeyCode	The char returned from PermalinkBusinessKey.getCodeEx().
static char	PermalinkCode	The char returned from Permalink.getCodeEx().
static char	RawCode	The char returned from Raw.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 ReportColumnFormat	safeValueOf(String value)	Helper function to return the ReportColumnFormat represented by value.
static ReportColumnFormat	valueOf(char code)	Helper function to return the ReportColumnFormat represented by code.
static ReportColumnFormat	valueOf(Character code)	Helper function to return the ReportColumnFormat represented by code.
static ReportColumnFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ReportColumnFormat	valueOfCode(String code)	Helper function to return the ReportColumnFormat represented by code.
static ReportColumnFormat[]	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

Raw

public static final ReportColumnFormat Raw

Displays the raw value from the database

Formatted

public static final ReportColumnFormat Formatted

Displays a formated value depending on the object type

BusinessKey

public static final ReportColumnFormat BusinessKey

Display the business key, if applicable, otherwise the formatted value

Permalink

public static final ReportColumnFormat Permalink

Display a permalink to the object, if applicable, otherwise the formatted value

PermalinkBusinessKey

public static final ReportColumnFormat PermalinkBusinessKey

Display a permalink with the business key at the link test

Field Detail

RawCode

public static final char RawCode

The char returned from Raw.getCodeEx().

See Also:

Raw, Constant Field Values

FormattedCode

public static final char FormattedCode

The char returned from Formatted.getCodeEx().

See Also:

Formatted, Constant Field Values

BusinessKeyCode

public static final char BusinessKeyCode

The char returned from BusinessKey.getCodeEx().

See Also:

BusinessKey, Constant Field Values

PermalinkCode

public static final char PermalinkCode

The char returned from Permalink.getCodeEx().

See Also:

Permalink, Constant Field Values

PermalinkBusinessKeyCode

public static final char PermalinkBusinessKeyCode

The char returned from PermalinkBusinessKey.getCodeEx().

See Also:

PermalinkBusinessKey, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

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

safeValueOf

public static ReportColumnFormat safeValueOf(String value)

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

See Also:

valueOf(String)

valueOf

public static ReportColumnFormat valueOf(Character code)

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

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

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

valueOf

public static ReportColumnFormat valueOf(char code)

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

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

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

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

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

Returns:

the database code for the enumeration