Enum OraAppsBatchJobPhase
- java.lang.Object
- 
- java.lang.Enum<OraAppsBatchJobPhase>
- 
- com.redwood.scheduler.api.model.enumeration.OraAppsBatchJobPhase
 
 
- 
- All Implemented Interfaces:
- BaseSchedulerEnumeration<OraAppsBatchJobPhase,Character>,- SchedulerEnumeration<OraAppsBatchJobPhase>,- Serializable,- Comparable<OraAppsBatchJobPhase>
 
 public enum OraAppsBatchJobPhase extends Enum<OraAppsBatchJobPhase> implements SchedulerEnumeration<OraAppsBatchJobPhase> What phase a OraApps batch job can have (Character Enumeration)
- 
- 
Field SummaryFields Modifier and Type Field Description static charCompletedCodeThe char returned from Completed.getCodeEx().static charInactiveCodeThe char returned from Inactive.getCodeEx().static charInitialCodeThe char returned from Initial.getCodeEx().static charPendingCodeThe char returned from Pending.getCodeEx().static charRunningCodeThe char returned from Running.getCodeEx().
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description chargetCodeEx()Get the code that is used to represent this enumeration in the database.CharactergetCodeExCharacter()Get the code that is used to represent this enumeration in the database.StringgetCodeExString()Get the code that is used to represent this enumeration in the database.CharactergetCodeExValue()Return the code for the enumeration item as the database type of this enumeration.StringgetDescriptionKey()Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.JobStatusStategetMappedJobStatusState()StringgetTranslationEN()Get the English name of this enumeration.StringgetTranslationKey()Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static OraAppsBatchJobPhasesafeValueOf(String value)Helper function to return the OraAppsBatchJobPhase represented byvalue.static OraAppsBatchJobPhasevalueOf(char code)Helper function to return the OraAppsBatchJobPhase represented by code.static OraAppsBatchJobPhasevalueOf(Character code)Helper function to return the OraAppsBatchJobPhase represented by code.static OraAppsBatchJobPhasevalueOf(String name)Returns the enum constant of this type with the specified name.static OraAppsBatchJobPhasevalueOfCode(String code)Helper function to return the OraAppsBatchJobPhase represented by code.static OraAppsBatchJobPhase[]values()Returns an array containing the constants of this enum type, in the order they are declared.- 
Methods inherited from class java.lang.Enumclone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 - 
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumerationname, ordinal
 - 
Methods inherited from interface java.lang.ComparablecompareTo
 
- 
 
- 
- 
- 
Enum Constant Detail- 
Initialpublic static final OraAppsBatchJobPhase Initial The process phase is initial.
 - 
Pendingpublic static final OraAppsBatchJobPhase Pending The process phase is pending.
 - 
Runningpublic static final OraAppsBatchJobPhase Running The process phase is currently running.
 - 
Completedpublic static final OraAppsBatchJobPhase Completed The process phase is completed.
 - 
Inactivepublic static final OraAppsBatchJobPhase Inactive The process phase is inactive.
 
- 
 - 
Field Detail- 
InitialCodepublic static final char InitialCode The char returned from Initial.getCodeEx().- See Also:
- Initial, Constant Field Values
 
 - 
PendingCodepublic static final char PendingCode The char returned from Pending.getCodeEx().- See Also:
- Pending, Constant Field Values
 
 - 
RunningCodepublic static final char RunningCode The char returned from Running.getCodeEx().- See Also:
- Running, Constant Field Values
 
 - 
CompletedCodepublic static final char CompletedCode The char returned from Completed.getCodeEx().- See Also:
- Completed, Constant Field Values
 
 - 
InactiveCodepublic static final char InactiveCode The char returned from Inactive.getCodeEx().- See Also:
- Inactive, Constant Field Values
 
 
- 
 - 
Method Detail- 
valuespublic static OraAppsBatchJobPhase[] 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 (OraAppsBatchJobPhase c : OraAppsBatchJobPhase.values()) System.out.println(c); - Returns:
- an array containing the constants of this enum type, in the order they are declared
 
 - 
valueOfpublic static OraAppsBatchJobPhase 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
 
 - 
getMappedJobStatusStatepublic JobStatusState getMappedJobStatusState() 
 - 
valueOfCodepublic static OraAppsBatchJobPhase valueOfCode(String code) Helper function to return the OraAppsBatchJobPhase 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 OraAppsBatchJobPhase
- Returns:
- The OraAppsBatchJobPhase corresponding to code, or null, if code is null, longer than one character, or not a valid code
 
 - 
safeValueOfpublic static OraAppsBatchJobPhase safeValueOf(String value) Helper function to return the OraAppsBatchJobPhase represented byvalue. Ifvalueis null, or not a valid OraAppsBatchJobPhase 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 OraAppsBatchJobPhase corresponding to value, or null, ifvalueis null, or not a valid enumeration
- See Also:
- valueOf(String)
 
 - 
valueOfpublic static OraAppsBatchJobPhase valueOf(Character code) Helper function to return the OraAppsBatchJobPhase represented by code. If code is null, or not a valid OraAppsBatchJobPhase code then this method will return null.- Parameters:
- code- Character that is one of the codes for HandlerAction
- Returns:
- The OraAppsBatchJobPhase corresponding to code, or null, if code is null, or not a valid code
 
 - 
valueOfpublic static OraAppsBatchJobPhase valueOf(char code) Helper function to return the OraAppsBatchJobPhase represented by code. If code is not a valid OraAppsBatchJobPhase code then this method will return null.- Parameters:
- code- char that is one of the codes for HandlerAction
- Returns:
- The OraAppsBatchJobPhase corresponding to code, or null, if code is not a valid code
 
 - 
getCodeExpublic char getCodeEx() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExin interface- SchedulerEnumeration<OraAppsBatchJobPhase>
- Returns:
- the database code for the enumeration
 
 - 
getCodeExValuepublic Character getCodeExValue() Description copied from interface:BaseSchedulerEnumerationReturn the code for the enumeration item as the database type of this enumeration.- Specified by:
- getCodeExValuein interface- BaseSchedulerEnumeration<OraAppsBatchJobPhase,Character>
- Returns:
- the enumeration code
 
 - 
getCodeExCharacterpublic Character getCodeExCharacter() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExCharacterin interface- SchedulerEnumeration<OraAppsBatchJobPhase>
- Returns:
- the database code for the enumeration
 
 - 
getTranslationKeypublic String getTranslationKey() Description copied from interface:BaseSchedulerEnumerationGet the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
- getTranslationKeyin interface- BaseSchedulerEnumeration<OraAppsBatchJobPhase,Character>
- Returns:
- the key.
 
 - 
getTranslationENpublic String getTranslationEN() Description copied from interface:BaseSchedulerEnumerationGet the English name of this enumeration.- Specified by:
- getTranslationENin interface- BaseSchedulerEnumeration<OraAppsBatchJobPhase,Character>
- Returns:
- the English name of this enumeration.
 
 - 
getDescriptionKeypublic String getDescriptionKey() Description copied from interface:BaseSchedulerEnumerationGet the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
- getDescriptionKeyin interface- BaseSchedulerEnumeration<OraAppsBatchJobPhase,Character>
- Returns:
- the key that can be passed to
         SchedulerSession.translateField(String)to retrieve the translated description.
 
 - 
getCodeExStringpublic String getCodeExString() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExStringin interface- SchedulerEnumeration<OraAppsBatchJobPhase>
- Returns:
- the database code for the enumeration
 
 
- 
 
-