Enum JobMaintenance
- java.lang.Object
- 
- java.lang.Enum<JobMaintenance>
- 
- com.redwood.scheduler.api.model.enumeration.JobMaintenance
 
 
- 
- All Implemented Interfaces:
- BaseSchedulerEnumeration<JobMaintenance,Character>,- SchedulerEnumeration<JobMaintenance>,- Serializable,- Comparable<JobMaintenance>
 
 public enum JobMaintenance extends Enum<JobMaintenance> implements SchedulerEnumeration<JobMaintenance> The maintenance level for the Job. (Character Enumeration)
- 
- 
Field SummaryFields Modifier and Type Field Description static charCustomCodeThe char returned from Custom.getCodeEx().static charStandardCodeThe char returned from Standard.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.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 JobMaintenancesafeValueOf(String value)Helper function to return the JobMaintenance represented byvalue.static JobMaintenancevalueOf(char code)Helper function to return the JobMaintenance represented by code.static JobMaintenancevalueOf(Character code)Helper function to return the JobMaintenance represented by code.static JobMaintenancevalueOf(String name)Returns the enum constant of this type with the specified name.static JobMaintenancevalueOfCode(String code)Helper function to return the JobMaintenance represented by code.static JobMaintenance[]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- 
Standardpublic static final JobMaintenance Standard Standard system maintenance.
 - 
Custompublic static final JobMaintenance Custom Custom defined maintenance.
 
- 
 - 
Field Detail- 
StandardCodepublic static final char StandardCode The char returned from Standard.getCodeEx().- See Also:
- Standard, Constant Field Values
 
 - 
CustomCodepublic static final char CustomCode The char returned from Custom.getCodeEx().- See Also:
- Custom, Constant Field Values
 
 
- 
 - 
Method Detail- 
valuespublic static JobMaintenance[] 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 (JobMaintenance c : JobMaintenance.values()) System.out.println(c); - Returns:
- an array containing the constants of this enum type, in the order they are declared
 
 - 
valueOfpublic static JobMaintenance 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
 
 - 
valueOfCodepublic static JobMaintenance valueOfCode(String code) Helper function to return the JobMaintenance 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 JobMaintenance
- Returns:
- The JobMaintenance corresponding to code, or null, if code is null, longer than one character, or not a valid code
 
 - 
safeValueOfpublic static JobMaintenance safeValueOf(String value) Helper function to return the JobMaintenance represented byvalue. Ifvalueis null, or not a valid JobMaintenance 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 JobMaintenance corresponding to value, or null, ifvalueis null, or not a valid enumeration
- See Also:
- valueOf(String)
 
 - 
valueOfpublic static JobMaintenance valueOf(Character code) Helper function to return the JobMaintenance represented by code. If code is null, or not a valid JobMaintenance code then this method will return null.- Parameters:
- code- Character that is one of the codes for HandlerAction
- Returns:
- The JobMaintenance corresponding to code, or null, if code is null, or not a valid code
 
 - 
valueOfpublic static JobMaintenance valueOf(char code) Helper function to return the JobMaintenance represented by code. If code is not a valid JobMaintenance code then this method will return null.- Parameters:
- code- char that is one of the codes for HandlerAction
- Returns:
- The JobMaintenance 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<JobMaintenance>
- 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<JobMaintenance,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<JobMaintenance>
- 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<JobMaintenance,Character>
- Returns:
- the key.
 
 - 
getTranslationENpublic String getTranslationEN() Description copied from interface:BaseSchedulerEnumerationGet the English name of this enumeration.- Specified by:
- getTranslationENin interface- BaseSchedulerEnumeration<JobMaintenance,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<JobMaintenance,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<JobMaintenance>
- Returns:
- the database code for the enumeration
 
 
- 
 
-