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

All Implemented Interfaces:

BaseSchedulerEnumeration<JobGroupStatus,Character>, SchedulerEnumeration<JobGroupStatus>, Serializable, Comparable<JobGroupStatus>
```
public enum JobGroupStatus
extends Enum<JobGroupStatus>
implements SchedulerEnumeration<JobGroupStatus>
```
The statuses for a job group. (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`Active`	The recurrence has processes in a non final state.
`Finished`	The recurrence and all its processes are finished.
`FinishedEndDate`	The recurrence reached the end date.
`FinishedFinalJobStatusAction`	The recurrence is finished because the handler for the final process status is set to "Stop Submit Frame".
`FinishedJobCount`	The recurrence reached the maximum number of processes.
`FinishedManually`	The recurrence is finished on a user request.
`FinishedSubmitFrame`	The recurrence reached the end of the submit frame.
`Held`	The recurrence was put on hold.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`ActiveCode`	The char returned from Active.getCodeEx().
`static char`	`FinishedCode`	The char returned from Finished.getCodeEx().
`static char`	`FinishedEndDateCode`	The char returned from FinishedEndDate.getCodeEx().
`static char`	`FinishedFinalJobStatusActionCode`	The char returned from FinishedFinalJobStatusAction.getCodeEx().
`static char`	`FinishedJobCountCode`	The char returned from FinishedJobCount.getCodeEx().
`static char`	`FinishedManuallyCode`	The char returned from FinishedManually.getCodeEx().
`static char`	`FinishedSubmitFrameCode`	The char returned from FinishedSubmitFrame.getCodeEx().
`static char`	`HeldCode`	The char returned from Held.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 JobGroupStatus`	`safeValueOf(String value)`	Helper function to return the JobGroupStatus represented by `value`.
`static JobGroupStatus`	`valueOf(char code)`	Helper function to return the JobGroupStatus represented by code.
`static JobGroupStatus`	`valueOf(Character code)`	Helper function to return the JobGroupStatus represented by code.
`static JobGroupStatus`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static JobGroupStatus`	`valueOfCode(String code)`	Helper function to return the JobGroupStatus represented by code.
`static JobGroupStatus[]`	`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
  - Active
```
public static final JobGroupStatus Active
```
    The recurrence has processes in a non final state.
  - Held
```
public static final JobGroupStatus Held
```
    The recurrence was put on hold.
  - FinishedJobCount
```
public static final JobGroupStatus FinishedJobCount
```
    The recurrence reached the maximum number of processes.
  - FinishedEndDate
```
public static final JobGroupStatus FinishedEndDate
```
    The recurrence reached the end date.
  - FinishedManually
```
public static final JobGroupStatus FinishedManually
```
    The recurrence is finished on a user request.
  - FinishedSubmitFrame
```
public static final JobGroupStatus FinishedSubmitFrame
```
    The recurrence reached the end of the submit frame.
  - FinishedFinalJobStatusAction
```
public static final JobGroupStatus FinishedFinalJobStatusAction
```
    The recurrence is finished because the handler for the final process status is set to "Stop Submit Frame".
  - Finished
```
public static final JobGroupStatus Finished
```
    The recurrence and all its processes are finished.
- Field Detail
  - ActiveCode
```
public static final char ActiveCode
```
    The char returned from Active.getCodeEx().
    
    See Also:
    
    Active, Constant Field Values
  - HeldCode
```
public static final char HeldCode
```
    The char returned from Held.getCodeEx().
    
    See Also:
    
    Held, Constant Field Values
  - FinishedJobCountCode
```
public static final char FinishedJobCountCode
```
    The char returned from FinishedJobCount.getCodeEx().
    
    See Also:
    
    FinishedJobCount, Constant Field Values
  - FinishedEndDateCode
```
public static final char FinishedEndDateCode
```
    The char returned from FinishedEndDate.getCodeEx().
    
    See Also:
    
    FinishedEndDate, Constant Field Values
  - FinishedManuallyCode
```
public static final char FinishedManuallyCode
```
    The char returned from FinishedManually.getCodeEx().
    
    See Also:
    
    FinishedManually, Constant Field Values
  - FinishedSubmitFrameCode
```
public static final char FinishedSubmitFrameCode
```
    The char returned from FinishedSubmitFrame.getCodeEx().
    
    See Also:
    
    FinishedSubmitFrame, Constant Field Values
  - FinishedFinalJobStatusActionCode
```
public static final char FinishedFinalJobStatusActionCode
```
    The char returned from FinishedFinalJobStatusAction.getCodeEx().
    
    See Also:
    
    FinishedFinalJobStatusAction, Constant Field Values
  - FinishedCode
```
public static final char FinishedCode
```
    The char returned from Finished.getCodeEx().
    
    See Also:
    
    Finished, Constant Field Values
- Method Detail
  - values
```
public static JobGroupStatus[] 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 (JobGroupStatus c : JobGroupStatus.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static JobGroupStatus 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 JobGroupStatus valueOfCode(String code)
```
    Helper function to return the JobGroupStatus 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 JobGroupStatus
    
    Returns:
    
    The JobGroupStatus corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static JobGroupStatus safeValueOf(String value)
```
    Helper function to return the JobGroupStatus represented by value. If value is null, or not a valid JobGroupStatus 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 JobGroupStatus corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static JobGroupStatus valueOf(Character code)
```
    Helper function to return the JobGroupStatus represented by code. If code is null, or not a valid JobGroupStatus code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The JobGroupStatus corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static JobGroupStatus valueOf(char code)
```
    Helper function to return the JobGroupStatus represented by code. If code is not a valid JobGroupStatus code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The JobGroupStatus 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<JobGroupStatus>
    
    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<JobGroupStatus,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<JobGroupStatus>
    
    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<JobGroupStatus,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<JobGroupStatus,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<JobGroupStatus,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<JobGroupStatus>
    
    Returns:
    
    the database code for the enumeration

Enum JobGroupStatus

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

Active

Held

FinishedJobCount

FinishedEndDate

FinishedManually

FinishedSubmitFrame

FinishedFinalJobStatusAction

Finished

Field Detail

ActiveCode

HeldCode

FinishedJobCountCode

FinishedEndDateCode

FinishedManuallyCode

FinishedSubmitFrameCode

FinishedFinalJobStatusActionCode

FinishedCode

Method Detail

values

valueOf

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString