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

All Implemented Interfaces:

BaseSchedulerEnumeration<SimpleConstraintSort,Integer>, SchedulerIntegerEnumeration<SimpleConstraintSort>, Serializable, Comparable<SimpleConstraintSort>
```
public enum SimpleConstraintSort
extends Enum<SimpleConstraintSort>
implements SchedulerIntegerEnumeration<SimpleConstraintSort>
```
The sorting for simple constraints (ascending, descending, or none). (Integer Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant	Description
`Ascending`	The constraint values will be sorted in ascending order.
`Descending`	The constraint values will be sorted in descending order.
`None`	No sorting will be done by the system, the constraint developer is responsible for the order of the values.

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`AscendingCode`	The int returned from Ascending.getCodeEx().
`static int`	`DescendingCode`	The int returned from Descending.getCodeEx().
`static int`	`NoneCode`	The int returned from None.getCodeEx().

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getCodeEx()`	Get the code that is used to represent this enumeration in the database.
`Integer`	`getCodeExInteger()`	Get the code that is used to represent this enumeration in the database.
`Integer`	`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 SimpleConstraintSort`	`safeValueOf(String value)`	Helper function to return the SimpleConstraintSort represented by `value`.
`static SimpleConstraintSort`	`valueOf(int code)`	Helper function to return the SimpleConstraintSort represented by code.
`static SimpleConstraintSort`	`valueOf(Integer code)`	Helper function to return the SimpleConstraintSort represented by code.
`static SimpleConstraintSort`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static SimpleConstraintSort`	`valueOfCode(String code)`	Helper function to return the SimpleConstraintSort represented by code.
`static SimpleConstraintSort[]`	`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
  - Ascending
```
public static final SimpleConstraintSort Ascending
```
    The constraint values will be sorted in ascending order. This is the default.
  - Descending
```
public static final SimpleConstraintSort Descending
```
    The constraint values will be sorted in descending order.
  - None
```
public static final SimpleConstraintSort None
```
    No sorting will be done by the system, the constraint developer is responsible for the order of the values.
- Field Detail
  - AscendingCode
```
public static final int AscendingCode
```
    The int returned from Ascending.getCodeEx().
    
    See Also:
    
    Ascending, Constant Field Values
  - DescendingCode
```
public static final int DescendingCode
```
    The int returned from Descending.getCodeEx().
    
    See Also:
    
    Descending, Constant Field Values
  - NoneCode
```
public static final int NoneCode
```
    The int returned from None.getCodeEx().
    
    See Also:
    
    None, Constant Field Values
- Method Detail
  - values
```
public static SimpleConstraintSort[] 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 (SimpleConstraintSort c : SimpleConstraintSort.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static SimpleConstraintSort 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 SimpleConstraintSort valueOfCode(String code)
```
    Helper function to return the SimpleConstraintSort 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 SimpleConstraintSort
    
    Returns:
    
    The SimpleConstraintSort corresponding to code, or null.
  - safeValueOf
```
public static SimpleConstraintSort safeValueOf(String value)
```
    Helper function to return the SimpleConstraintSort represented by value. If value is null, or not a valid SimpleConstraintSort 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 SimpleConstraintSort corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static SimpleConstraintSort valueOf(Integer code)
```
    Helper function to return the SimpleConstraintSort represented by code. If code is null, or not a valid SimpleConstraintSort code then this method will return null.
    
    Parameters:
    
    code - Integer that is one of the codes for HandlerAction
    
    Returns:
    
    The SimpleConstraintSort corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static SimpleConstraintSort valueOf(int code)
```
    Helper function to return the SimpleConstraintSort represented by code. If code is not a valid SimpleConstraintSort code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The SimpleConstraintSort corresponding to code, or null, if code is not a valid code
  - getCodeEx
```
public int getCodeEx()
```
    Description copied from interface: SchedulerIntegerEnumeration
    
    Get the code that is used to represent this enumeration in the database.
    
    Specified by:
    
    getCodeEx in interface SchedulerIntegerEnumeration<SimpleConstraintSort>
    
    Returns:
    
    the database code for the enumeration
  - getCodeExValue
```
public Integer 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<SimpleConstraintSort,Integer>
    
    Returns:
    
    the enumeration code
  - getCodeExInteger
```
public Integer getCodeExInteger()
```
    Description copied from interface: SchedulerIntegerEnumeration
    
    Get the code that is used to represent this enumeration in the database.
    
    Specified by:
    
    getCodeExInteger in interface SchedulerIntegerEnumeration<SimpleConstraintSort>
    
    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<SimpleConstraintSort,Integer>
    
    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<SimpleConstraintSort,Integer>
    
    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<SimpleConstraintSort,Integer>
    
    Returns:
    
    the key that can be passed to SchedulerSession.translateField(String) to retrieve the translated description.

Enum SimpleConstraintSort

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

Ascending

Descending

None

Field Detail

AscendingCode

DescendingCode

NoneCode

Method Detail

values

valueOf

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExInteger

getTranslationKey

getTranslationEN

getDescriptionKey