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

All Implemented Interfaces:

BaseSchedulerEnumeration<QueueStatus,Character>, SchedulerEnumeration<QueueStatus>, Serializable, Comparable<QueueStatus>
```
public enum QueueStatus
extends Enum<QueueStatus>
implements SchedulerEnumeration<QueueStatus>
```
This indicates the combined status of a Queue, this is calculated from a number of factors, including, the Queue itself and all of the associated ProcessProviders. (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`ClosedHeld`	The Queue is closed because it was manually held by an operator.
`ClosedNoProcessServers`	The queue has no assigned process servers, and so cannot be opened.
`ClosedProcessServersShutdown`	The Queue is closed because all of the associated ProcessServers are either Shutdown, or otherwise unavailable for scheduling.
`ClosedQueueProvidersHeld`	The Queue is closed because all of the associated QueueProviders are also Held.
`ClosedSchedulersHeldOrNotRunning`	The queue is currently closed as all of the QueueProviders and ProcessServers are either Held or Shutdown.
`ClosedTimeWindow`	The queue is currently closed as its associated TimeWindow is also closed.
`Full`	The Queue is full and is currently not accepting Processes.
`Open`	The Queue is currently open and accepting Processes.
`UnknownRecalculatingTimeWindow`	The current status of the Queue is unknown, as it needs to be recalculated as the TimeWindow has changed.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`ClosedHeldCode`	The char returned from ClosedHeld.getCodeEx().
`static char`	`ClosedNoProcessServersCode`	The char returned from ClosedNoProcessServers.getCodeEx().
`static char`	`ClosedProcessServersShutdownCode`	The char returned from ClosedProcessServersShutdown.getCodeEx().
`static char`	`ClosedQueueProvidersHeldCode`	The char returned from ClosedQueueProvidersHeld.getCodeEx().
`static char`	`ClosedSchedulersHeldOrNotRunningCode`	The char returned from ClosedSchedulersHeldOrNotRunning.getCodeEx().
`static char`	`ClosedTimeWindowCode`	The char returned from ClosedTimeWindow.getCodeEx().
`static char`	`FullCode`	The char returned from Full.getCodeEx().
`static char`	`OpenCode`	The char returned from Open.getCodeEx().
`static char`	`UnknownRecalculatingTimeWindowCode`	The char returned from UnknownRecalculatingTimeWindow.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.
`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 QueueStatus`	`safeValueOf(String value)`	Helper function to return the QueueStatus represented by `value`.
`static QueueStatus`	`valueOf(char code)`	Helper function to return the QueueStatus represented by code.
`static QueueStatus`	`valueOf(Character code)`	Helper function to return the QueueStatus represented by code.
`static QueueStatus`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static QueueStatus`	`valueOfCode(String code)`	Helper function to return the QueueStatus represented by code.
`static QueueStatus[]`	`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
  - ClosedHeld
```
public static final QueueStatus ClosedHeld
```
    The Queue is closed because it was manually held by an operator.
  - UnknownRecalculatingTimeWindow
```
public static final QueueStatus UnknownRecalculatingTimeWindow
```
    The current status of the Queue is unknown, as it needs to be recalculated as the TimeWindow has changed.
  - ClosedQueueProvidersHeld
```
public static final QueueStatus ClosedQueueProvidersHeld
```
    The Queue is closed because all of the associated QueueProviders are also Held.
  - ClosedProcessServersShutdown
```
public static final QueueStatus ClosedProcessServersShutdown
```
    The Queue is closed because all of the associated ProcessServers are either Shutdown, or otherwise unavailable for scheduling.
  - ClosedTimeWindow
```
public static final QueueStatus ClosedTimeWindow
```
    The queue is currently closed as its associated TimeWindow is also closed.
  - ClosedSchedulersHeldOrNotRunning
```
public static final QueueStatus ClosedSchedulersHeldOrNotRunning
```
    The queue is currently closed as all of the QueueProviders and ProcessServers are either Held or Shutdown.
  - ClosedNoProcessServers
```
public static final QueueStatus ClosedNoProcessServers
```
    The queue has no assigned process servers, and so cannot be opened.
  - Open
```
public static final QueueStatus Open
```
    The Queue is currently open and accepting Processes.
  - Full
```
public static final QueueStatus Full
```
    The Queue is full and is currently not accepting Processes.
- Field Detail
  - ClosedHeldCode
```
public static final char ClosedHeldCode
```
    The char returned from ClosedHeld.getCodeEx().
    
    See Also:
    
    ClosedHeld, Constant Field Values
  - UnknownRecalculatingTimeWindowCode
```
public static final char UnknownRecalculatingTimeWindowCode
```
    The char returned from UnknownRecalculatingTimeWindow.getCodeEx().
    
    See Also:
    
    UnknownRecalculatingTimeWindow, Constant Field Values
  - ClosedQueueProvidersHeldCode
```
public static final char ClosedQueueProvidersHeldCode
```
    The char returned from ClosedQueueProvidersHeld.getCodeEx().
    
    See Also:
    
    ClosedQueueProvidersHeld, Constant Field Values
  - ClosedProcessServersShutdownCode
```
public static final char ClosedProcessServersShutdownCode
```
    The char returned from ClosedProcessServersShutdown.getCodeEx().
    
    See Also:
    
    ClosedProcessServersShutdown, Constant Field Values
  - ClosedTimeWindowCode
```
public static final char ClosedTimeWindowCode
```
    The char returned from ClosedTimeWindow.getCodeEx().
    
    See Also:
    
    ClosedTimeWindow, Constant Field Values
  - ClosedSchedulersHeldOrNotRunningCode
```
public static final char ClosedSchedulersHeldOrNotRunningCode
```
    The char returned from ClosedSchedulersHeldOrNotRunning.getCodeEx().
    
    See Also:
    
    ClosedSchedulersHeldOrNotRunning, Constant Field Values
  - ClosedNoProcessServersCode
```
public static final char ClosedNoProcessServersCode
```
    The char returned from ClosedNoProcessServers.getCodeEx().
    
    See Also:
    
    ClosedNoProcessServers, Constant Field Values
  - OpenCode
```
public static final char OpenCode
```
    The char returned from Open.getCodeEx().
    
    See Also:
    
    Open, Constant Field Values
  - FullCode
```
public static final char FullCode
```
    The char returned from Full.getCodeEx().
    
    See Also:
    
    Full, Constant Field Values
- Method Detail
  - values
```
public static QueueStatus[] 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 (QueueStatus c : QueueStatus.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static QueueStatus 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
  - valueOfCode
```
public static QueueStatus valueOfCode(String code)
```
    Helper function to return the QueueStatus 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 QueueStatus
    
    Returns:
    
    The QueueStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static QueueStatus safeValueOf(String value)
```
    Helper function to return the QueueStatus represented by value. If value is null, or not a valid QueueStatus 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 QueueStatus corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static QueueStatus valueOf(Character code)
```
    Helper function to return the QueueStatus represented by code. If code is null, or not a valid QueueStatus code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The QueueStatus corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static QueueStatus valueOf(char code)
```
    Helper function to return the QueueStatus represented by code. If code is not a valid QueueStatus code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The QueueStatus 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<QueueStatus>
    
    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<QueueStatus,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<QueueStatus>
    
    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<QueueStatus,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<QueueStatus,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<QueueStatus,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<QueueStatus>
    
    Returns:
    
    the database code for the enumeration

Enum QueueStatus

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

ClosedHeld

UnknownRecalculatingTimeWindow

ClosedQueueProvidersHeld

ClosedProcessServersShutdown

ClosedTimeWindow

ClosedSchedulersHeldOrNotRunning

ClosedNoProcessServers

Open

Full

Field Detail

ClosedHeldCode

UnknownRecalculatingTimeWindowCode

ClosedQueueProvidersHeldCode

ClosedProcessServersShutdownCode

ClosedTimeWindowCode

ClosedSchedulersHeldOrNotRunningCode

ClosedNoProcessServersCode

OpenCode

FullCode

Method Detail

values

valueOf

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString