Enum PseudoDashboardDial
- java.lang.Object
- 
- java.lang.Enum<PseudoDashboardDial>
- 
- com.redwood.scheduler.api.model.enumeration.PseudoDashboardDial
 
 
- 
- All Implemented Interfaces:
- BaseSchedulerEnumeration<PseudoDashboardDial,Integer>,- SchedulerIntegerEnumeration<PseudoDashboardDial>,- Serializable,- Comparable<PseudoDashboardDial>
 
 public enum PseudoDashboardDial extends Enum<PseudoDashboardDial> implements SchedulerIntegerEnumeration<PseudoDashboardDial> The rules for matching applications. (Integer Enumeration)
- 
- 
Enum Constant SummaryEnum Constants Enum Constant Description AggregateLoadFake unique id to indicate the a dashboard dial displaying the aggregate system load.QueuedJobsFake unique id to indicate the a dashboard dial displaying the total number of queued processes.RunningJobsFake unique id to indicate the a dashboard dial displaying the total number of running processes.
 - 
Field SummaryFields Modifier and Type Field Description static intAggregateLoadCodeThe int returned from AggregateLoad.getCodeEx().static intQueuedJobsCodeThe int returned from QueuedJobs.getCodeEx().static intRunningJobsCodeThe int returned from RunningJobs.getCodeEx().
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetCodeEx()Get the code that is used to represent this enumeration in the database.IntegergetCodeExInteger()Get the code that is used to represent this enumeration in the database.IntegergetCodeExValue()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.intgetminimumMaximum()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 PseudoDashboardDialsafeValueOf(String value)Helper function to return the PseudoDashboardDial represented byvalue.static PseudoDashboardDialvalueOf(int code)Helper function to return the PseudoDashboardDial represented by code.static PseudoDashboardDialvalueOf(Integer code)Helper function to return the PseudoDashboardDial represented by code.static PseudoDashboardDialvalueOf(String name)Returns the enum constant of this type with the specified name.static PseudoDashboardDialvalueOfCode(String code)Helper function to return the PseudoDashboardDial represented by code.static PseudoDashboardDial[]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- 
AggregateLoadpublic static final PseudoDashboardDial AggregateLoad Fake unique id to indicate the a dashboard dial displaying the aggregate system load.
 - 
RunningJobspublic static final PseudoDashboardDial RunningJobs Fake unique id to indicate the a dashboard dial displaying the total number of running processes.
 - 
QueuedJobspublic static final PseudoDashboardDial QueuedJobs Fake unique id to indicate the a dashboard dial displaying the total number of queued processes.
 
- 
 - 
Field Detail- 
AggregateLoadCodepublic static final int AggregateLoadCode The int returned from AggregateLoad.getCodeEx().- See Also:
- AggregateLoad, Constant Field Values
 
 - 
RunningJobsCodepublic static final int RunningJobsCode The int returned from RunningJobs.getCodeEx().- See Also:
- RunningJobs, Constant Field Values
 
 - 
QueuedJobsCodepublic static final int QueuedJobsCode The int returned from QueuedJobs.getCodeEx().- See Also:
- QueuedJobs, Constant Field Values
 
 
- 
 - 
Method Detail- 
valuespublic static PseudoDashboardDial[] 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 (PseudoDashboardDial c : PseudoDashboardDial.values()) System.out.println(c); - Returns:
- an array containing the constants of this enum type, in the order they are declared
 
 - 
valueOfpublic static PseudoDashboardDial 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
 
 - 
getminimumMaximumpublic int getminimumMaximum() 
 - 
valueOfCodepublic static PseudoDashboardDial valueOfCode(String code) Helper function to return the PseudoDashboardDial represented by code. If code is null, empty, or not a valid code then this method will return null.- Parameters:
- code- A string that is one of the codes for PseudoDashboardDial
- Returns:
- The PseudoDashboardDial corresponding to code, or null.
 
 - 
safeValueOfpublic static PseudoDashboardDial safeValueOf(String value) Helper function to return the PseudoDashboardDial represented byvalue. Ifvalueis null, or not a valid PseudoDashboardDial 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 PseudoDashboardDial corresponding to value, or null, ifvalueis null, or not a valid enumeration
- See Also:
- valueOf(String)
 
 - 
valueOfpublic static PseudoDashboardDial valueOf(Integer code) Helper function to return the PseudoDashboardDial represented by code. If code is null, or not a valid PseudoDashboardDial code then this method will return null.- Parameters:
- code- Integer that is one of the codes for HandlerAction
- Returns:
- The PseudoDashboardDial corresponding to code, or null, if code is null, or not a valid code
 
 - 
valueOfpublic static PseudoDashboardDial valueOf(int code) Helper function to return the PseudoDashboardDial represented by code. If code is not a valid PseudoDashboardDial code then this method will return null.- Parameters:
- code- char that is one of the codes for HandlerAction
- Returns:
- The PseudoDashboardDial corresponding to code, or null, if code is not a valid code
 
 - 
getCodeExpublic int getCodeEx() Description copied from interface:SchedulerIntegerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExin interface- SchedulerIntegerEnumeration<PseudoDashboardDial>
- Returns:
- the database code for the enumeration
 
 - 
getCodeExValuepublic Integer getCodeExValue() Description copied from interface:BaseSchedulerEnumerationReturn the code for the enumeration item as the database type of this enumeration.- Specified by:
- getCodeExValuein interface- BaseSchedulerEnumeration<PseudoDashboardDial,Integer>
- Returns:
- the enumeration code
 
 - 
getCodeExIntegerpublic Integer getCodeExInteger() Description copied from interface:SchedulerIntegerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExIntegerin interface- SchedulerIntegerEnumeration<PseudoDashboardDial>
- 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<PseudoDashboardDial,Integer>
- Returns:
- the key.
 
 - 
getTranslationENpublic String getTranslationEN() Description copied from interface:BaseSchedulerEnumerationGet the English name of this enumeration.- Specified by:
- getTranslationENin interface- BaseSchedulerEnumeration<PseudoDashboardDial,Integer>
- 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<PseudoDashboardDial,Integer>
- Returns:
- the key that can be passed to
         SchedulerSession.translateField(String)to retrieve the translated description.
 
 
- 
 
-