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

Enum PeopleSoftDistributionJobStatus

java.lang.Object

java.lang.Enum<PeopleSoftDistributionJobStatus>

com.redwood.scheduler.api.model.enumeration.PeopleSoftDistributionJobStatus

All Implemented Interfaces:

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

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

What distribution status a PeopleSoft batch process can have (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Delete	The batch process has deleted the output.
Generated	Process is generating the output.
None	The process has nothing to distribute.
NotAvailable	The process has no output to distribute.
NotPosted	Process could not post the output.
Posted	The batch process has distribute the output.
Posting	The batch process has to distribute the output.
Processing	The process is processing the output to distribute.

Field Summary

Fields

Modifier and Type	Field	Description
static char	DeleteCode	The char returned from Delete.getCodeEx().
static char	GeneratedCode	The char returned from Generated.getCodeEx().
static char	NoneCode	The char returned from None.getCodeEx().
static char	NotAvailableCode	The char returned from NotAvailable.getCodeEx().
static char	NotPostedCode	The char returned from NotPosted.getCodeEx().
static char	PostedCode	The char returned from Posted.getCodeEx().
static char	PostingCode	The char returned from Posting.getCodeEx().
static char	ProcessingCode	The char returned from Processing.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.
JobStatus	getMappedJobStatus()
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 PeopleSoftDistributionJobStatus	safeValueOf(String value)	Helper function to return the PeopleSoftDistributionJobStatus represented by value.
static PeopleSoftDistributionJobStatus	valueOf(char code)	Helper function to return the PeopleSoftDistributionJobStatus represented by code.
static PeopleSoftDistributionJobStatus	valueOf(Character code)	Helper function to return the PeopleSoftDistributionJobStatus represented by code.
static PeopleSoftDistributionJobStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PeopleSoftDistributionJobStatus	valueOfCode(String code)	Helper function to return the PeopleSoftDistributionJobStatus represented by code.
static PeopleSoftDistributionJobStatus[]	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

None

public static final PeopleSoftDistributionJobStatus None

The process has nothing to distribute.

NotAvailable

public static final PeopleSoftDistributionJobStatus NotAvailable

The process has no output to distribute.

Processing

public static final PeopleSoftDistributionJobStatus Processing

The process is processing the output to distribute.

Generated

public static final PeopleSoftDistributionJobStatus Generated

Process is generating the output.

NotPosted

public static final PeopleSoftDistributionJobStatus NotPosted

Process could not post the output.

Posted

public static final PeopleSoftDistributionJobStatus Posted

The batch process has distribute the output.

Delete

public static final PeopleSoftDistributionJobStatus Delete

The batch process has deleted the output.

Posting

public static final PeopleSoftDistributionJobStatus Posting

The batch process has to distribute the output.

Field Detail

NoneCode

public static final char NoneCode

The char returned from None.getCodeEx().

See Also:

None, Constant Field Values

NotAvailableCode

public static final char NotAvailableCode

The char returned from NotAvailable.getCodeEx().

See Also:

NotAvailable, Constant Field Values

ProcessingCode

public static final char ProcessingCode

The char returned from Processing.getCodeEx().

See Also:

Processing, Constant Field Values

GeneratedCode

public static final char GeneratedCode

The char returned from Generated.getCodeEx().

See Also:

Generated, Constant Field Values

NotPostedCode

public static final char NotPostedCode

The char returned from NotPosted.getCodeEx().

See Also:

NotPosted, Constant Field Values

PostedCode

public static final char PostedCode

The char returned from Posted.getCodeEx().

See Also:

Posted, Constant Field Values

DeleteCode

public static final char DeleteCode

The char returned from Delete.getCodeEx().

See Also:

Delete, Constant Field Values

PostingCode

public static final char PostingCode

The char returned from Posting.getCodeEx().

See Also:

Posting, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getMappedJobStatus

public JobStatus getMappedJobStatus()

valueOfCode

public static PeopleSoftDistributionJobStatus valueOfCode(String code)

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

Returns:

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

safeValueOf

public static PeopleSoftDistributionJobStatus safeValueOf(String value)

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

See Also:

valueOf(String)

valueOf

public static PeopleSoftDistributionJobStatus valueOf(Character code)

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

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

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

valueOf

public static PeopleSoftDistributionJobStatus valueOf(char code)

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

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

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

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

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

Returns:

the database code for the enumeration