Enum PeopleSoftBatchJobStatus
- java.lang.Object
-
- java.lang.Enum<PeopleSoftBatchJobStatus>
-
- com.redwood.scheduler.api.model.enumeration.PeopleSoftBatchJobStatus
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<PeopleSoftBatchJobStatus,Character>
,SchedulerEnumeration<PeopleSoftBatchJobStatus>
,Serializable
,Comparable<PeopleSoftBatchJobStatus>
public enum PeopleSoftBatchJobStatus extends Enum<PeopleSoftBatchJobStatus> implements SchedulerEnumeration<PeopleSoftBatchJobStatus>
What status a PeopleSoft batch job can have (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Blocked
Process is blocked.Cancel
The batch process is in status cancel.Cancelled
Request is killed.Delete
The process is deleted.Error
process is in Error.Generated
Process is generated.Hold
process is put on hold.Initiated
Process is started.NoSuccess
Process is not successfully ended.NotSuccessful
Process is not successfully ended.Pending
Process is pending.Posted
Process is posted.Posting
Process is being post.Processing
Process is being processed.Queued
Process is queued.Resend
Process is resend.Restart
Process should be restarted.Success
Process has successfully run.UnableToPost
Process can't be posted.Warning
Process has status warning.
-
Field Summary
Fields Modifier and Type Field Description static char
BlockedCode
The char returned from Blocked.getCodeEx().static char
CancelCode
The char returned from Cancel.getCodeEx().static char
CancelledCode
The char returned from Cancelled.getCodeEx().static char
DeleteCode
The char returned from Delete.getCodeEx().static char
ErrorCode
The char returned from Error.getCodeEx().static char
GeneratedCode
The char returned from Generated.getCodeEx().static char
HoldCode
The char returned from Hold.getCodeEx().static char
InitiatedCode
The char returned from Initiated.getCodeEx().static char
NoSuccessCode
The char returned from NoSuccess.getCodeEx().static char
NotSuccessfulCode
The char returned from NotSuccessful.getCodeEx().static char
PendingCode
The char returned from Pending.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().static char
QueuedCode
The char returned from Queued.getCodeEx().static char
ResendCode
The char returned from Resend.getCodeEx().static char
RestartCode
The char returned from Restart.getCodeEx().static char
SuccessCode
The char returned from Success.getCodeEx().static char
UnableToPostCode
The char returned from UnableToPost.getCodeEx().static char
WarningCode
The char returned from Warning.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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 PeopleSoftBatchJobStatus
safeValueOf(String value)
Helper function to return the PeopleSoftBatchJobStatus represented byvalue
.static PeopleSoftBatchJobStatus
valueOf(char code)
Helper function to return the PeopleSoftBatchJobStatus represented by code.static PeopleSoftBatchJobStatus
valueOf(Character code)
Helper function to return the PeopleSoftBatchJobStatus represented by code.static PeopleSoftBatchJobStatus
valueOf(String name)
Returns the enum constant of this type with the specified name.static PeopleSoftBatchJobStatus
valueOfCode(String code)
Helper function to return the PeopleSoftBatchJobStatus represented by code.static PeopleSoftBatchJobStatus[]
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 interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
Cancel
public static final PeopleSoftBatchJobStatus Cancel
The batch process is in status cancel.
-
Delete
public static final PeopleSoftBatchJobStatus Delete
The process is deleted.
-
Error
public static final PeopleSoftBatchJobStatus Error
process is in Error.
-
Hold
public static final PeopleSoftBatchJobStatus Hold
process is put on hold.
-
Queued
public static final PeopleSoftBatchJobStatus Queued
Process is queued.
-
Initiated
public static final PeopleSoftBatchJobStatus Initiated
Process is started.
-
Processing
public static final PeopleSoftBatchJobStatus Processing
Process is being processed.
-
Cancelled
public static final PeopleSoftBatchJobStatus Cancelled
Request is killed.
-
Success
public static final PeopleSoftBatchJobStatus Success
Process has successfully run.
-
NotSuccessful
public static final PeopleSoftBatchJobStatus NotSuccessful
Process is not successfully ended.
-
Posted
public static final PeopleSoftBatchJobStatus Posted
Process is posted.
-
UnableToPost
public static final PeopleSoftBatchJobStatus UnableToPost
Process can't be posted.
-
Resend
public static final PeopleSoftBatchJobStatus Resend
Process is resend.
-
Posting
public static final PeopleSoftBatchJobStatus Posting
Process is being post.
-
Generated
public static final PeopleSoftBatchJobStatus Generated
Process is generated.
-
Pending
public static final PeopleSoftBatchJobStatus Pending
Process is pending.
-
Warning
public static final PeopleSoftBatchJobStatus Warning
Process has status warning.
-
Blocked
public static final PeopleSoftBatchJobStatus Blocked
Process is blocked.
-
Restart
public static final PeopleSoftBatchJobStatus Restart
Process should be restarted.
-
NoSuccess
public static final PeopleSoftBatchJobStatus NoSuccess
Process is not successfully ended.
-
-
Field Detail
-
CancelCode
public static final char CancelCode
The char returned from Cancel.getCodeEx().- See Also:
Cancel
, Constant Field Values
-
DeleteCode
public static final char DeleteCode
The char returned from Delete.getCodeEx().- See Also:
Delete
, Constant Field Values
-
ErrorCode
public static final char ErrorCode
The char returned from Error.getCodeEx().- See Also:
Error
, Constant Field Values
-
HoldCode
public static final char HoldCode
The char returned from Hold.getCodeEx().- See Also:
Hold
, Constant Field Values
-
QueuedCode
public static final char QueuedCode
The char returned from Queued.getCodeEx().- See Also:
Queued
, Constant Field Values
-
InitiatedCode
public static final char InitiatedCode
The char returned from Initiated.getCodeEx().- See Also:
Initiated
, Constant Field Values
-
ProcessingCode
public static final char ProcessingCode
The char returned from Processing.getCodeEx().- See Also:
Processing
, Constant Field Values
-
CancelledCode
public static final char CancelledCode
The char returned from Cancelled.getCodeEx().- See Also:
Cancelled
, Constant Field Values
-
SuccessCode
public static final char SuccessCode
The char returned from Success.getCodeEx().- See Also:
Success
, Constant Field Values
-
NotSuccessfulCode
public static final char NotSuccessfulCode
The char returned from NotSuccessful.getCodeEx().- See Also:
NotSuccessful
, Constant Field Values
-
PostedCode
public static final char PostedCode
The char returned from Posted.getCodeEx().- See Also:
Posted
, Constant Field Values
-
UnableToPostCode
public static final char UnableToPostCode
The char returned from UnableToPost.getCodeEx().- See Also:
UnableToPost
, Constant Field Values
-
ResendCode
public static final char ResendCode
The char returned from Resend.getCodeEx().- See Also:
Resend
, Constant Field Values
-
PostingCode
public static final char PostingCode
The char returned from Posting.getCodeEx().- See Also:
Posting
, Constant Field Values
-
GeneratedCode
public static final char GeneratedCode
The char returned from Generated.getCodeEx().- See Also:
Generated
, Constant Field Values
-
PendingCode
public static final char PendingCode
The char returned from Pending.getCodeEx().- See Also:
Pending
, Constant Field Values
-
WarningCode
public static final char WarningCode
The char returned from Warning.getCodeEx().- See Also:
Warning
, Constant Field Values
-
BlockedCode
public static final char BlockedCode
The char returned from Blocked.getCodeEx().- See Also:
Blocked
, Constant Field Values
-
RestartCode
public static final char RestartCode
The char returned from Restart.getCodeEx().- See Also:
Restart
, Constant Field Values
-
NoSuccessCode
public static final char NoSuccessCode
The char returned from NoSuccess.getCodeEx().- See Also:
NoSuccess
, Constant Field Values
-
-
Method Detail
-
values
public static PeopleSoftBatchJobStatus[] 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 (PeopleSoftBatchJobStatus c : PeopleSoftBatchJobStatus.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static PeopleSoftBatchJobStatus 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 nameNullPointerException
- if the argument is null
-
getMappedJobStatus
public JobStatus getMappedJobStatus()
-
valueOfCode
public static PeopleSoftBatchJobStatus valueOfCode(String code)
Helper function to return the PeopleSoftBatchJobStatus 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 PeopleSoftBatchJobStatus- Returns:
- The PeopleSoftBatchJobStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static PeopleSoftBatchJobStatus safeValueOf(String value)
Helper function to return the PeopleSoftBatchJobStatus represented byvalue
. Ifvalue
is null, or not a valid PeopleSoftBatchJobStatus 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 invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The PeopleSoftBatchJobStatus corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static PeopleSoftBatchJobStatus valueOf(Character code)
Helper function to return the PeopleSoftBatchJobStatus represented by code. If code is null, or not a valid PeopleSoftBatchJobStatus code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The PeopleSoftBatchJobStatus corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static PeopleSoftBatchJobStatus valueOf(char code)
Helper function to return the PeopleSoftBatchJobStatus represented by code. If code is not a valid PeopleSoftBatchJobStatus code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The PeopleSoftBatchJobStatus 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 interfaceSchedulerEnumeration<PeopleSoftBatchJobStatus>
- 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 interfaceBaseSchedulerEnumeration<PeopleSoftBatchJobStatus,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 interfaceSchedulerEnumeration<PeopleSoftBatchJobStatus>
- 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 interfaceBaseSchedulerEnumeration<PeopleSoftBatchJobStatus,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<PeopleSoftBatchJobStatus,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 interfaceBaseSchedulerEnumeration<PeopleSoftBatchJobStatus,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 interfaceSchedulerEnumeration<PeopleSoftBatchJobStatus>
- Returns:
- the database code for the enumeration
-
-