Enum AlertStatus
- java.lang.Object
- 
- java.lang.Enum<AlertStatus>
- 
- com.redwood.scheduler.api.model.enumeration.AlertStatus
 
 
- 
- All Implemented Interfaces:
- BaseSchedulerEnumeration<AlertStatus,Character>,- SchedulerEnumeration<AlertStatus>,- Serializable,- Comparable<AlertStatus>
 
 public enum AlertStatus extends Enum<AlertStatus> implements SchedulerEnumeration<AlertStatus> The status of a work action in the Action Component work list. (Character Enumeration)
- 
- 
Enum Constant SummaryEnum Constants Enum Constant Description AcknowledgedThe alert has been acknowledged.EscalatedThe alert has been escalated.NotAcknowledgedThe alert has not been acknowledged.ResentThe alert has been resent.
 - 
Field SummaryFields Modifier and Type Field Description static charAcknowledgedCodeThe char returned from Acknowledged.getCodeEx().static charEscalatedCodeThe char returned from Escalated.getCodeEx().static charNotAcknowledgedCodeThe char returned from NotAcknowledged.getCodeEx().static charResentCodeThe char returned from Resent.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 AlertStatussafeValueOf(String value)Helper function to return the AlertStatus represented byvalue.static AlertStatusvalueOf(char code)Helper function to return the AlertStatus represented by code.static AlertStatusvalueOf(Character code)Helper function to return the AlertStatus represented by code.static AlertStatusvalueOf(String name)Returns the enum constant of this type with the specified name.static AlertStatusvalueOfCode(String code)Helper function to return the AlertStatus represented by code.static AlertStatus[]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- 
NotAcknowledgedpublic static final AlertStatus NotAcknowledged The alert has not been acknowledged.
 - 
Acknowledgedpublic static final AlertStatus Acknowledged The alert has been acknowledged.
 - 
Escalatedpublic static final AlertStatus Escalated The alert has been escalated.
 - 
Resentpublic static final AlertStatus Resent The alert has been resent.
 
- 
 - 
Field Detail- 
NotAcknowledgedCodepublic static final char NotAcknowledgedCode The char returned from NotAcknowledged.getCodeEx().- See Also:
- NotAcknowledged, Constant Field Values
 
 - 
AcknowledgedCodepublic static final char AcknowledgedCode The char returned from Acknowledged.getCodeEx().- See Also:
- Acknowledged, Constant Field Values
 
 - 
EscalatedCodepublic static final char EscalatedCode The char returned from Escalated.getCodeEx().- See Also:
- Escalated, Constant Field Values
 
 - 
ResentCodepublic static final char ResentCode The char returned from Resent.getCodeEx().- See Also:
- Resent, Constant Field Values
 
 
- 
 - 
Method Detail- 
valuespublic static AlertStatus[] 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 (AlertStatus c : AlertStatus.values()) System.out.println(c); - Returns:
- an array containing the constants of this enum type, in the order they are declared
 
 - 
valueOfpublic static AlertStatus 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 AlertStatus valueOfCode(String code) Helper function to return the AlertStatus 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 AlertStatus
- Returns:
- The AlertStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
 
 - 
safeValueOfpublic static AlertStatus safeValueOf(String value) Helper function to return the AlertStatus represented byvalue. Ifvalueis null, or not a valid AlertStatus 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 AlertStatus corresponding to value, or null, ifvalueis null, or not a valid enumeration
- See Also:
- valueOf(String)
 
 - 
valueOfpublic static AlertStatus valueOf(Character code) Helper function to return the AlertStatus represented by code. If code is null, or not a valid AlertStatus code then this method will return null.- Parameters:
- code- Character that is one of the codes for HandlerAction
- Returns:
- The AlertStatus corresponding to code, or null, if code is null, or not a valid code
 
 - 
valueOfpublic static AlertStatus valueOf(char code) Helper function to return the AlertStatus represented by code. If code is not a valid AlertStatus code then this method will return null.- Parameters:
- code- char that is one of the codes for HandlerAction
- Returns:
- The AlertStatus 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<AlertStatus>
- 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<AlertStatus,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<AlertStatus>
- 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<AlertStatus,Character>
- Returns:
- the key.
 
 - 
getTranslationENpublic String getTranslationEN() Description copied from interface:BaseSchedulerEnumerationGet the English name of this enumeration.- Specified by:
- getTranslationENin interface- BaseSchedulerEnumeration<AlertStatus,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<AlertStatus,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<AlertStatus>
- Returns:
- the database code for the enumeration
 
 
- 
 
-