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

All Implemented Interfaces:

BaseSchedulerEnumeration<SchedulingParameterName,Character>, SchedulerEnumeration<SchedulingParameterName>, Serializable, Comparable<SchedulingParameterName>
```
public enum SchedulingParameterName
extends Enum<SchedulingParameterName>
implements SchedulerEnumeration<SchedulingParameterName>
```
Name of the scheduling-parameter. (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`HoldOnSubmit`	Whether the process should be held during submit.
`MinimumOpenDurationExpression`	The minimum number of milliseconds that should be available in the TimeWindow of the Job, the Job's Queue or the intersection of both, before this job will be submitted.
`Priority`	The priority with which the process should be scheduled.
`Queue`	The queue to which the process should be assigned.
`StartTime`	The start time of the process.
`SubmitDisabled`	Whether the process should be disabled during submit.
`TimeWindow`	The time window the process should run in.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`HoldOnSubmitCode`	The char returned from HoldOnSubmit.getCodeEx().
`static char`	`MinimumOpenDurationExpressionCode`	The char returned from MinimumOpenDurationExpression.getCodeEx().
`static char`	`PriorityCode`	The char returned from Priority.getCodeEx().
`static char`	`QueueCode`	The char returned from Queue.getCodeEx().
`static char`	`StartTimeCode`	The char returned from StartTime.getCodeEx().
`static char`	`SubmitDisabledCode`	The char returned from SubmitDisabled.getCodeEx().
`static char`	`TimeWindowCode`	The char returned from TimeWindow.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 SchedulingParameterName`	`safeValueOf(String value)`	Helper function to return the SchedulingParameterName represented by `value`.
`static SchedulingParameterName`	`valueOf(char code)`	Helper function to return the SchedulingParameterName represented by code.
`static SchedulingParameterName`	`valueOf(Character code)`	Helper function to return the SchedulingParameterName represented by code.
`static SchedulingParameterName`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static SchedulingParameterName`	`valueOfCode(String code)`	Helper function to return the SchedulingParameterName represented by code.
`static SchedulingParameterName[]`	`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
  - HoldOnSubmit
```
public static final SchedulingParameterName HoldOnSubmit
```
    Whether the process should be held during submit.
  - Priority
```
public static final SchedulingParameterName Priority
```
    The priority with which the process should be scheduled.
  - Queue
```
public static final SchedulingParameterName Queue
```
    The queue to which the process should be assigned.
  - TimeWindow
```
public static final SchedulingParameterName TimeWindow
```
    The time window the process should run in.
  - MinimumOpenDurationExpression
```
public static final SchedulingParameterName MinimumOpenDurationExpression
```
    The minimum number of milliseconds that should be available in the TimeWindow of the Job, the Job's Queue or the intersection of both, before this job will be submitted.
  - StartTime
```
public static final SchedulingParameterName StartTime
```
    The start time of the process.
  - SubmitDisabled
```
public static final SchedulingParameterName SubmitDisabled
```
    Whether the process should be disabled during submit.
- Field Detail
  - HoldOnSubmitCode
```
public static final char HoldOnSubmitCode
```
    The char returned from HoldOnSubmit.getCodeEx().
    
    See Also:
    
    HoldOnSubmit, Constant Field Values
  - PriorityCode
```
public static final char PriorityCode
```
    The char returned from Priority.getCodeEx().
    
    See Also:
    
    Priority, Constant Field Values
  - QueueCode
```
public static final char QueueCode
```
    The char returned from Queue.getCodeEx().
    
    See Also:
    
    Queue, Constant Field Values
  - TimeWindowCode
```
public static final char TimeWindowCode
```
    The char returned from TimeWindow.getCodeEx().
    
    See Also:
    
    TimeWindow, Constant Field Values
  - MinimumOpenDurationExpressionCode
```
public static final char MinimumOpenDurationExpressionCode
```
    The char returned from MinimumOpenDurationExpression.getCodeEx().
    
    See Also:
    
    MinimumOpenDurationExpression, Constant Field Values
  - StartTimeCode
```
public static final char StartTimeCode
```
    The char returned from StartTime.getCodeEx().
    
    See Also:
    
    StartTime, Constant Field Values
  - SubmitDisabledCode
```
public static final char SubmitDisabledCode
```
    The char returned from SubmitDisabled.getCodeEx().
    
    See Also:
    
    SubmitDisabled, Constant Field Values
- Method Detail
  - values
```
public static SchedulingParameterName[] 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 (SchedulingParameterName c : SchedulingParameterName.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SchedulingParameterName 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 SchedulingParameterName valueOfCode(String code)
```
    Helper function to return the SchedulingParameterName 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 SchedulingParameterName
    
    Returns:
    
    The SchedulingParameterName corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static SchedulingParameterName safeValueOf(String value)
```
    Helper function to return the SchedulingParameterName represented by value. If value is null, or not a valid SchedulingParameterName 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 SchedulingParameterName corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static SchedulingParameterName valueOf(Character code)
```
    Helper function to return the SchedulingParameterName represented by code. If code is null, or not a valid SchedulingParameterName code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The SchedulingParameterName corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static SchedulingParameterName valueOf(char code)
```
    Helper function to return the SchedulingParameterName represented by code. If code is not a valid SchedulingParameterName code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The SchedulingParameterName 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<SchedulingParameterName>
    
    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<SchedulingParameterName,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<SchedulingParameterName>
    
    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<SchedulingParameterName,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<SchedulingParameterName,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<SchedulingParameterName,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<SchedulingParameterName>
    
    Returns:
    
    the database code for the enumeration

Enum SchedulingParameterName

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

HoldOnSubmit

Priority

Queue

TimeWindow

MinimumOpenDurationExpression

StartTime

SubmitDisabled

Field Detail

HoldOnSubmitCode

PriorityCode

QueueCode

TimeWindowCode

MinimumOpenDurationExpressionCode

StartTimeCode

SubmitDisabledCode

Method Detail

values

valueOf

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString