Enum ApplicationMatch
- java.lang.Object
-
- java.lang.Enum<ApplicationMatch>
-
- com.redwood.scheduler.api.model.enumeration.ApplicationMatch
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ApplicationMatch,Character>
,SchedulerEnumeration<ApplicationMatch>
,Serializable
,Comparable<ApplicationMatch>
public enum ApplicationMatch extends Enum<ApplicationMatch> implements SchedulerEnumeration<ApplicationMatch>
The rules for matching applications. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AllObjects
Match all objects including objects without an application.AnyObjectInAnApplication
Match any object in an Application.ExactApplication
Matches an exact Application.NoApplication
Matches results with no Application set.SubApplications
Matches result with the matching Application or any of it child applications.
-
Field Summary
Fields Modifier and Type Field Description static ApplicationMatch
AllApplications
An alias for AllObjectsstatic char
AllObjectsCode
The char returned from AllObjects.getCodeEx().static ApplicationMatch
AnyApplication
An alias for AnyObjectInAnApplicationstatic char
AnyObjectInAnApplicationCode
The char returned from AnyObjectInAnApplication.getCodeEx().static char
ExactApplicationCode
The char returned from ExactApplication.getCodeEx().static char
NoApplicationCode
The char returned from NoApplication.getCodeEx().static char
SubApplicationsCode
The char returned from SubApplications.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 ApplicationMatch
safeValueOf(String value)
Helper function to return the ApplicationMatch represented byvalue
.static ApplicationMatch
valueOf(char code)
Helper function to return the ApplicationMatch represented by code.static ApplicationMatch
valueOf(Character code)
Helper function to return the ApplicationMatch represented by code.static ApplicationMatch
valueOf(String name)
Returns the enum constant of this type with the specified name.static ApplicationMatch
valueOfCode(String code)
Helper function to return the ApplicationMatch represented by code.static ApplicationMatch[]
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
-
AllObjects
public static final ApplicationMatch AllObjects
Match all objects including objects without an application.
-
ExactApplication
public static final ApplicationMatch ExactApplication
Matches an exact Application.
-
NoApplication
public static final ApplicationMatch NoApplication
Matches results with no Application set.
-
AnyObjectInAnApplication
public static final ApplicationMatch AnyObjectInAnApplication
Match any object in an Application.
-
SubApplications
public static final ApplicationMatch SubApplications
Matches result with the matching Application or any of it child applications.
-
-
Field Detail
-
AllObjectsCode
public static final char AllObjectsCode
The char returned from AllObjects.getCodeEx().- See Also:
AllObjects
, Constant Field Values
-
AllApplications
public static final ApplicationMatch AllApplications
An alias for AllObjects
-
ExactApplicationCode
public static final char ExactApplicationCode
The char returned from ExactApplication.getCodeEx().- See Also:
ExactApplication
, Constant Field Values
-
NoApplicationCode
public static final char NoApplicationCode
The char returned from NoApplication.getCodeEx().- See Also:
NoApplication
, Constant Field Values
-
AnyObjectInAnApplicationCode
public static final char AnyObjectInAnApplicationCode
The char returned from AnyObjectInAnApplication.getCodeEx().- See Also:
AnyObjectInAnApplication
, Constant Field Values
-
AnyApplication
public static final ApplicationMatch AnyApplication
An alias for AnyObjectInAnApplication
-
SubApplicationsCode
public static final char SubApplicationsCode
The char returned from SubApplications.getCodeEx().- See Also:
SubApplications
, Constant Field Values
-
-
Method Detail
-
values
public static ApplicationMatch[] 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 (ApplicationMatch c : ApplicationMatch.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ApplicationMatch 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 ApplicationMatch valueOfCode(String code)
Helper function to return the ApplicationMatch 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 ApplicationMatch- Returns:
- The ApplicationMatch corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ApplicationMatch safeValueOf(String value)
Helper function to return the ApplicationMatch represented byvalue
. Ifvalue
is null, or not a valid ApplicationMatch 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 ApplicationMatch corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ApplicationMatch valueOf(Character code)
Helper function to return the ApplicationMatch represented by code. If code is null, or not a valid ApplicationMatch code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ApplicationMatch corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ApplicationMatch valueOf(char code)
Helper function to return the ApplicationMatch represented by code. If code is not a valid ApplicationMatch code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ApplicationMatch 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<ApplicationMatch>
- 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<ApplicationMatch,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<ApplicationMatch>
- 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<ApplicationMatch,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<ApplicationMatch,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<ApplicationMatch,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<ApplicationMatch>
- Returns:
- the database code for the enumeration
-
-