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

All Implemented Interfaces:

BaseSchedulerEnumeration<ObjectSearchSortRule,Character>, SchedulerEnumeration<ObjectSearchSortRule>, Serializable, Comparable<ObjectSearchSortRule>
```
public enum ObjectSearchSortRule
extends Enum<ObjectSearchSortRule>
implements SchedulerEnumeration<ObjectSearchSortRule>
```
The rule for sorting the search results. (Character Enumeration)

Enum Constant Summary

Enum Constants
Enum Constant Description

ObjectType
Results are sorted by ObjectType

Relevance
Results are sorted according to how many matches they have for search conditions.

Field Summary

Fields
Modifier and Type	Field	Description
`static char`	`ObjectTypeCode`	The char returned from ObjectType.getCodeEx().
`static char`	`RelevanceCode`	The char returned from Relevance.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 ObjectSearchSortRule`	`safeValueOf(String value)`	Helper function to return the ObjectSearchSortRule represented by `value`.
`static ObjectSearchSortRule`	`valueOf(char code)`	Helper function to return the ObjectSearchSortRule represented by code.
`static ObjectSearchSortRule`	`valueOf(Character code)`	Helper function to return the ObjectSearchSortRule represented by code.
`static ObjectSearchSortRule`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static ObjectSearchSortRule`	`valueOfCode(String code)`	Helper function to return the ObjectSearchSortRule represented by code.
`static ObjectSearchSortRule[]`	`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
  - Relevance
```
public static final ObjectSearchSortRule Relevance
```
    Results are sorted according to how many matches they have for search conditions.
  - ObjectType
```
public static final ObjectSearchSortRule ObjectType
```
    Results are sorted by ObjectType
- Field Detail
  - RelevanceCode
```
public static final char RelevanceCode
```
    The char returned from Relevance.getCodeEx().
    
    See Also:
    
    Relevance, Constant Field Values
  - ObjectTypeCode
```
public static final char ObjectTypeCode
```
    The char returned from ObjectType.getCodeEx().
    
    See Also:
    
    ObjectType, Constant Field Values
- Method Detail
  - values
```
public static ObjectSearchSortRule[] 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 (ObjectSearchSortRule c : ObjectSearchSortRule.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ObjectSearchSortRule 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 ObjectSearchSortRule valueOfCode(String code)
```
    Helper function to return the ObjectSearchSortRule 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 ObjectSearchSortRule
    
    Returns:
    
    The ObjectSearchSortRule corresponding to code, or null, if code is null, longer than one character, or not a valid code
  - safeValueOf
```
public static ObjectSearchSortRule safeValueOf(String value)
```
    Helper function to return the ObjectSearchSortRule represented by value. If value is null, or not a valid ObjectSearchSortRule 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 ObjectSearchSortRule corresponding to value, or null, if value is null, or not a valid enumeration
    
    See Also:
    
    valueOf(String)
  - valueOf
```
public static ObjectSearchSortRule valueOf(Character code)
```
    Helper function to return the ObjectSearchSortRule represented by code. If code is null, or not a valid ObjectSearchSortRule code then this method will return null.
    
    Parameters:
    
    code - Character that is one of the codes for HandlerAction
    
    Returns:
    
    The ObjectSearchSortRule corresponding to code, or null, if code is null, or not a valid code
  - valueOf
```
public static ObjectSearchSortRule valueOf(char code)
```
    Helper function to return the ObjectSearchSortRule represented by code. If code is not a valid ObjectSearchSortRule code then this method will return null.
    
    Parameters:
    
    code - char that is one of the codes for HandlerAction
    
    Returns:
    
    The ObjectSearchSortRule 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<ObjectSearchSortRule>
    
    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<ObjectSearchSortRule,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<ObjectSearchSortRule>
    
    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<ObjectSearchSortRule,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<ObjectSearchSortRule,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<ObjectSearchSortRule,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<ObjectSearchSortRule>
    
    Returns:
    
    the database code for the enumeration

Enum Constant	Description
`ObjectType`	Results are sorted by ObjectType
`Relevance`	Results are sorted according to how many matches they have for search conditions.

Enum ObjectSearchSortRule

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

Relevance

ObjectType

Field Detail

RelevanceCode

ObjectTypeCode

Method Detail

values

valueOf

valueOfCode

safeValueOf

valueOf

valueOf

getCodeEx

getCodeExValue

getCodeExCharacter

getTranslationKey

getTranslationEN

getDescriptionKey

getCodeExString