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 SummaryEnum Constants Enum Constant Description AllObjectsMatch all objects including objects without an application.AnyObjectInAnApplicationMatch any object in an Application.ExactApplicationMatches an exact Application.NoApplicationMatches results with no Application set.SubApplicationsMatches result with the matching Application or any of it child applications.
 - 
Field SummaryFields Modifier and Type Field Description static ApplicationMatchAllApplicationsAn alias for AllObjectsstatic charAllObjectsCodeThe char returned from AllObjects.getCodeEx().static ApplicationMatchAnyApplicationAn alias for AnyObjectInAnApplicationstatic charAnyObjectInAnApplicationCodeThe char returned from AnyObjectInAnApplication.getCodeEx().static charExactApplicationCodeThe char returned from ExactApplication.getCodeEx().static charNoApplicationCodeThe char returned from NoApplication.getCodeEx().static charSubApplicationsCodeThe char returned from SubApplications.getCodeEx().
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description chargetCodeEx()Get the code that is used to represent this enumeration in the database.CharactergetCodeExCharacter()Get the code that is used to represent this enumeration in the database.StringgetCodeExString()Get the code that is used to represent this enumeration in the database.CharactergetCodeExValue()Return the code for the enumeration item as the database type of this enumeration.StringgetDescriptionKey()Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.StringgetTranslationEN()Get the English name of this enumeration.StringgetTranslationKey()Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.static ApplicationMatchsafeValueOf(String value)Helper function to return the ApplicationMatch represented byvalue.static ApplicationMatchvalueOf(char code)Helper function to return the ApplicationMatch represented by code.static ApplicationMatchvalueOf(Character code)Helper function to return the ApplicationMatch represented by code.static ApplicationMatchvalueOf(String name)Returns the enum constant of this type with the specified name.static ApplicationMatchvalueOfCode(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.Enumclone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 - 
Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumerationname, ordinal
 - 
Methods inherited from interface java.lang.ComparablecompareTo
 
- 
 
- 
- 
- 
Enum Constant Detail- 
AllObjectspublic static final ApplicationMatch AllObjects Match all objects including objects without an application.
 - 
ExactApplicationpublic static final ApplicationMatch ExactApplication Matches an exact Application.
 - 
NoApplicationpublic static final ApplicationMatch NoApplication Matches results with no Application set.
 - 
AnyObjectInAnApplicationpublic static final ApplicationMatch AnyObjectInAnApplication Match any object in an Application.
 - 
SubApplicationspublic static final ApplicationMatch SubApplications Matches result with the matching Application or any of it child applications.
 
- 
 - 
Field Detail- 
AllObjectsCodepublic static final char AllObjectsCode The char returned from AllObjects.getCodeEx().- See Also:
- AllObjects, Constant Field Values
 
 - 
AllApplicationspublic static final ApplicationMatch AllApplications An alias for AllObjects
 - 
ExactApplicationCodepublic static final char ExactApplicationCode The char returned from ExactApplication.getCodeEx().- See Also:
- ExactApplication, Constant Field Values
 
 - 
NoApplicationCodepublic static final char NoApplicationCode The char returned from NoApplication.getCodeEx().- See Also:
- NoApplication, Constant Field Values
 
 - 
AnyObjectInAnApplicationCodepublic static final char AnyObjectInAnApplicationCode The char returned from AnyObjectInAnApplication.getCodeEx().- See Also:
- AnyObjectInAnApplication, Constant Field Values
 
 - 
AnyApplicationpublic static final ApplicationMatch AnyApplication An alias for AnyObjectInAnApplication
 - 
SubApplicationsCodepublic static final char SubApplicationsCode The char returned from SubApplications.getCodeEx().- See Also:
- SubApplications, Constant Field Values
 
 
- 
 - 
Method Detail- 
valuespublic 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
 
 - 
valueOfpublic 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 name
- NullPointerException- if the argument is null
 
 - 
valueOfCodepublic 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
 
 - 
safeValueOfpublic static ApplicationMatch safeValueOf(String value) Helper function to return the ApplicationMatch represented byvalue. Ifvalueis 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, ifvalueis null, or not a valid enumeration
- See Also:
- valueOf(String)
 
 - 
valueOfpublic 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
 
 - 
valueOfpublic 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
 
 - 
getCodeExpublic char getCodeEx() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExin interface- SchedulerEnumeration<ApplicationMatch>
- Returns:
- the database code for the enumeration
 
 - 
getCodeExValuepublic Character getCodeExValue() Description copied from interface:BaseSchedulerEnumerationReturn the code for the enumeration item as the database type of this enumeration.- Specified by:
- getCodeExValuein interface- BaseSchedulerEnumeration<ApplicationMatch,Character>
- Returns:
- the enumeration code
 
 - 
getCodeExCharacterpublic Character getCodeExCharacter() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExCharacterin interface- SchedulerEnumeration<ApplicationMatch>
- Returns:
- the database code for the enumeration
 
 - 
getTranslationKeypublic String getTranslationKey() Description copied from interface:BaseSchedulerEnumerationGet the translation-key that must be used to retrieve the locale-specific name of this enumeration.- Specified by:
- getTranslationKeyin interface- BaseSchedulerEnumeration<ApplicationMatch,Character>
- Returns:
- the key.
 
 - 
getTranslationENpublic String getTranslationEN() Description copied from interface:BaseSchedulerEnumerationGet the English name of this enumeration.- Specified by:
- getTranslationENin interface- BaseSchedulerEnumeration<ApplicationMatch,Character>
- Returns:
- the English name of this enumeration.
 
 - 
getDescriptionKeypublic String getDescriptionKey() Description copied from interface:BaseSchedulerEnumerationGet the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.- Specified by:
- getDescriptionKeyin interface- BaseSchedulerEnumeration<ApplicationMatch,Character>
- Returns:
- the key that can be passed to
         SchedulerSession.translateField(String)to retrieve the translated description.
 
 - 
getCodeExStringpublic String getCodeExString() Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
- getCodeExStringin interface- SchedulerEnumeration<ApplicationMatch>
- Returns:
- the database code for the enumeration
 
 
- 
 
-