java.lang.Object
- java.lang.Enum<ProcessServerStatus>
- - com.redwood.scheduler.api.model.enumeration.ProcessServerStatus

All Implemented Interfaces:

BaseSchedulerEnumeration<ProcessServerStatus,Character>, SchedulerEnumeration<ProcessServerStatus>, Serializable, Comparable<ProcessServerStatus>
```
public enum ProcessServerStatus
extends Enum<ProcessServerStatus>
implements SchedulerEnumeration<ProcessServerStatus>
```
The current or desired status of the ProcessServer. (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`Connecting`	A ProcessServer service is currently trying to connect to the remote system.
`Created`	The ProcessServer has been created, but has never been started.
`Error`	The ProcessServer cannot process processes because of some failure condition, possible a resource restriction.
`Overloaded`	The ProcessServer is running above its load threshold.
`PartiallyRunning`	The ProcessServer and at least one service (but not all services) are running.
`Running`	The ProcessServer is currently running normally.
`Shutdown`	The ProcessServer is not currently running.
`ShutdownAbort`	The ProcessServer is being shutdown with the Abort Flag.
`ShutdownImmediate`	The ProcessServer is being shutdown immediately.
`ShutdownNormal`	The ProcessServer is being shutdown normally.
`Starting`	The ProcessServer is in the process of starting up.
`Unknown`	The state of the ProcessServer is not currently known.
`Updating`	A ProcessServer service is currently trying to update the software on the remote system.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`ConnectingCode`	The char returned from Connecting.getCodeEx().
`static char`	`CreatedCode`	The char returned from Created.getCodeEx().
`static char`	`ErrorCode`	The char returned from Error.getCodeEx().
`static char`	`OverloadedCode`	The char returned from Overloaded.getCodeEx().
`static char`	`PartiallyRunningCode`	The char returned from PartiallyRunning.getCodeEx().
`static char`	`RunningCode`	The char returned from Running.getCodeEx().
`static char`	`ShutdownAbortCode`	The char returned from ShutdownAbort.getCodeEx().
`static char`	`ShutdownCode`	The char returned from Shutdown.getCodeEx().
`static char`	`ShutdownImmediateCode`	The char returned from ShutdownImmediate.getCodeEx().
`static char`	`ShutdownNormalCode`	The char returned from ShutdownNormal.getCodeEx().
`static char`	`StartingCode`	The char returned from Starting.getCodeEx().
`static char`	`UnknownCode`	The char returned from Unknown.getCodeEx().
`static char`	`UpdatingCode`	The char returned from Updating.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.
`int`	`getPriority()`
`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 ProcessServerStatus`	`safeValueOf(String value)`	Helper function to return the ProcessServerStatus represented by `value`.
`static ProcessServerStatus`	`valueOf(char code)`	Helper function to return the ProcessServerStatus represented by code.
`static ProcessServerStatus`	`valueOf(Character code)`	Helper function to return the ProcessServerStatus represented by code.
`static ProcessServerStatus`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ProcessServerStatus`	`valueOfCode(String code)`	Helper function to return the ProcessServerStatus represented by code.
`static ProcessServerStatus[]`	`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 class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal

Methods inherited from interface java.lang.Comparable
compareTo

- Enum Constant Detail
  - Created
```
public static final ProcessServerStatus Created
```
    The ProcessServer has been created, but has never been started. This is also the value that the DesiredStatus attribute is reset to (and hence the only value seen in the database).
  - Starting
```
public static final ProcessServerStatus Starting
```
    The ProcessServer is in the process of starting up.
  - Running
```
public static final ProcessServerStatus Running
```
    The ProcessServer is currently running normally.
  - Shutdown
```
public static final ProcessServerStatus Shutdown
```
    The ProcessServer is not currently running.
  - ShutdownAbort
```
public static final ProcessServerStatus ShutdownAbort
```
    The ProcessServer is being shutdown with the Abort Flag.
  - ShutdownImmediate
```
public static final ProcessServerStatus ShutdownImmediate
```
    The ProcessServer is being shutdown immediately.
  - ShutdownNormal
```
public static final ProcessServerStatus ShutdownNormal
```
    The ProcessServer is being shutdown normally.
  - Unknown
```
public static final ProcessServerStatus Unknown
```
    The state of the ProcessServer is not currently known.
  - Connecting
```
public static final ProcessServerStatus Connecting
```
    A ProcessServer service is currently trying to connect to the remote system.
  - Updating
```
public static final ProcessServerStatus Updating
```
    A ProcessServer service is currently trying to update the software on the remote system.
  - PartiallyRunning
```
public static final ProcessServerStatus PartiallyRunning
```
    The ProcessServer and at least one service (but not all services) are running.
  - Overloaded
```
public static final ProcessServerStatus Overloaded
```
    The ProcessServer is running above its load threshold.
  - Error
```
public static final ProcessServerStatus Error
```
    The ProcessServer cannot process processes because of some failure condition, possible a resource restriction.
- Field Detail
  - CreatedCode
```
public static final char CreatedCode
```
    The char returned from Created.getCodeEx().
    
    See Also:
    
    Created, Constant Field Values
  - StartingCode
```
public static final char StartingCode
```
    The char returned from Starting.getCodeEx().
    
    See Also:
    
    Starting, Constant Field Values
  - RunningCode
```
public static final char RunningCode
```
    The char returned from Running.getCodeEx().
    
    See Also:
    
    Running, Constant Field Values
  - ShutdownCode
```
public static final char ShutdownCode
```
    The char returned from Shutdown.getCodeEx().
    
    See Also:
    
    Shutdown, Constant Field Values
  - ShutdownAbortCode
```
public static final char ShutdownAbortCode
```
    The char returned from ShutdownAbort.getCodeEx().
    
    See Also:
    
    ShutdownAbort, Constant Field Values
  - ShutdownImmediateCode
```
public static final char ShutdownImmediateCode
```
    The char returned from ShutdownImmediate.getCodeEx().
    
    See Also:
    
    ShutdownImmediate, Constant Field Values
  - ShutdownNormalCode
```
public static final char ShutdownNormalCode
```
    The char returned from ShutdownNormal.getCodeEx().
    
    See Also:
    
    ShutdownNormal, Constant Field Values
  - UnknownCode
```
public static final char UnknownCode
```
    The char returned from Unknown.getCodeEx().
    
    See Also:
    
    Unknown, Constant Field Values
  - ConnectingCode
```
public static final char ConnectingCode
```
    The char returned from Connecting.getCodeEx().
    
    See Also:
    
    Connecting, Constant Field Values
  - UpdatingCode
```
public static final char UpdatingCode
```
    The char returned from Updating.getCodeEx().
    
    See Also:
    
    Updating, Constant Field Values
  - PartiallyRunningCode
```
public static final char PartiallyRunningCode
```
    The char returned from PartiallyRunning.getCodeEx().
    
    See Also:
    
    PartiallyRunning, Constant Field Values
  - OverloadedCode
```
public static final char OverloadedCode
```
    The char returned from Overloaded.getCodeEx().
    
    See Also:
    
    Overloaded, Constant Field Values
  - ErrorCode
```
public static final char ErrorCode
```
    The char returned from Error.getCodeEx().
    
    See Also:
    
    Error, Constant Field Values
- Method Detail
  - values
```
public static ProcessServerStatus[] 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 (ProcessServerStatus c : ProcessServerStatus.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ProcessServerStatus 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
  - getPriority
```
public int getPriority()
```
  - valueOfCode
```
public static ProcessServerStatus valueOfCode(String code)
```
    Helper function to return the ProcessServerStatus 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 ProcessServerStatus
    
    Returns:
    
    The ProcessServerStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static ProcessServerStatus safeValueOf(String value)
```
    Helper function to return the ProcessServerStatus represented by value. If value is null, or not a valid ProcessServerStatus 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 invalid value, valueOf(String) will throw an IllegalArgumentException.
    
    Parameters:
    
    value - The string value that corresponds to the requested enumeration value
    
    Returns:
    
    The ProcessServerStatus corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static ProcessServerStatus valueOf(Character code)
```
    Helper function to return the ProcessServerStatus represented by code. If code is null, or not a valid ProcessServerStatus code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The ProcessServerStatus corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static ProcessServerStatus valueOf(char code)
```
    Helper function to return the ProcessServerStatus represented by code. If code is not a valid ProcessServerStatus code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The ProcessServerStatus 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 interface SchedulerEnumeration<ProcessServerStatus>
    
    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 interface BaseSchedulerEnumeration<ProcessServerStatus,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 interface SchedulerEnumeration<ProcessServerStatus>
    
    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 interface BaseSchedulerEnumeration<ProcessServerStatus,Character>
    
    Returns:
    
    the key.
  - getTranslationEN
```
public String getTranslationEN()
```
    Description copied from interface: BaseSchedulerEnumeration
    
    Get the English name of this enumeration.
    
    Specified by:
    
    getTranslationEN in interface BaseSchedulerEnumeration<ProcessServerStatus,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 interface BaseSchedulerEnumeration<ProcessServerStatus,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 interface SchedulerEnumeration<ProcessServerStatus>
    
    Returns:
    
    the database code for the enumeration

Enum ProcessServerStatus

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

Methods inherited from interface java.lang.Comparable

Enum Constant Detail

Created

Starting

Running

Shutdown

ShutdownAbort

ShutdownImmediate

ShutdownNormal

Unknown

Connecting

Updating

PartiallyRunning

Overloaded

Error

Field Detail

CreatedCode

StartingCode

RunningCode

ShutdownCode

ShutdownAbortCode

ShutdownImmediateCode

ShutdownNormalCode

UnknownCode

ConnectingCode

UpdatingCode

PartiallyRunningCode

OverloadedCode

ErrorCode

Method Detail

values

valueOf

getPriority

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString