Enum ObjectSearchResultType
- java.lang.Object
-
- java.lang.Enum<ObjectSearchResultType>
-
- com.redwood.scheduler.api.model.enumeration.ObjectSearchResultType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ObjectSearchResultType,Character>
,SchedulerEnumeration<ObjectSearchResultType>
,Serializable
,Comparable<ObjectSearchResultType>
public enum ObjectSearchResultType extends Enum<ObjectSearchResultType> implements SchedulerEnumeration<ObjectSearchResultType>
The type of results. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AllResults
Return all results that match the conditions.Count
Results the count of the matching results.Limited
Results the specified maximum number of results.
-
Field Summary
Fields Modifier and Type Field Description static char
AllResultsCode
The char returned from AllResults.getCodeEx().static char
CountCode
The char returned from Count.getCodeEx().static char
LimitedCode
The char returned from Limited.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 ObjectSearchResultType
safeValueOf(String value)
Helper function to return the ObjectSearchResultType represented byvalue
.static ObjectSearchResultType
valueOf(char code)
Helper function to return the ObjectSearchResultType represented by code.static ObjectSearchResultType
valueOf(Character code)
Helper function to return the ObjectSearchResultType represented by code.static ObjectSearchResultType
valueOf(String name)
Returns the enum constant of this type with the specified name.static ObjectSearchResultType
valueOfCode(String code)
Helper function to return the ObjectSearchResultType represented by code.static ObjectSearchResultType[]
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 interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
AllResults
public static final ObjectSearchResultType AllResults
Return all results that match the conditions.
-
Count
public static final ObjectSearchResultType Count
Results the count of the matching results.
-
Limited
public static final ObjectSearchResultType Limited
Results the specified maximum number of results.
-
-
Field Detail
-
AllResultsCode
public static final char AllResultsCode
The char returned from AllResults.getCodeEx().- See Also:
AllResults
, Constant Field Values
-
CountCode
public static final char CountCode
The char returned from Count.getCodeEx().- See Also:
Count
, Constant Field Values
-
LimitedCode
public static final char LimitedCode
The char returned from Limited.getCodeEx().- See Also:
Limited
, Constant Field Values
-
-
Method Detail
-
values
public static ObjectSearchResultType[] 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 (ObjectSearchResultType c : ObjectSearchResultType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ObjectSearchResultType 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 nameNullPointerException
- if the argument is null
-
valueOfCode
public static ObjectSearchResultType valueOfCode(String code)
Helper function to return the ObjectSearchResultType 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 ObjectSearchResultType- Returns:
- The ObjectSearchResultType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ObjectSearchResultType safeValueOf(String value)
Helper function to return the ObjectSearchResultType represented byvalue
. Ifvalue
is null, or not a valid ObjectSearchResultType 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 invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The ObjectSearchResultType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ObjectSearchResultType valueOf(Character code)
Helper function to return the ObjectSearchResultType represented by code. If code is null, or not a valid ObjectSearchResultType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ObjectSearchResultType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ObjectSearchResultType valueOf(char code)
Helper function to return the ObjectSearchResultType represented by code. If code is not a valid ObjectSearchResultType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ObjectSearchResultType 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 interfaceSchedulerEnumeration<ObjectSearchResultType>
- 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 interfaceBaseSchedulerEnumeration<ObjectSearchResultType,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 interfaceSchedulerEnumeration<ObjectSearchResultType>
- 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 interfaceBaseSchedulerEnumeration<ObjectSearchResultType,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<ObjectSearchResultType,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 interfaceBaseSchedulerEnumeration<ObjectSearchResultType,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 interfaceSchedulerEnumeration<ObjectSearchResultType>
- Returns:
- the database code for the enumeration
-
-