Enum SecurityClauseTweak
- java.lang.Object
-
- java.lang.Enum<SecurityClauseTweak>
-
- com.redwood.scheduler.api.model.enumeration.SecurityClauseTweak
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<SecurityClauseTweak,Character>,SchedulerEnumeration<SecurityClauseTweak>,Serializable,Comparable<SecurityClauseTweak>
public enum SecurityClauseTweak extends Enum<SecurityClauseTweak> implements SchedulerEnumeration<SecurityClauseTweak>
One specific tweak for the structure of the generated security clause (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ConvertType0 = default, no conversion.GenerateExistsDefault is true.PrecalculateObjectDefinitionDefault is false.SimplifyType0 = No simplification, reducing nested selects.UseExplicitAndForIsolationGroupDefault is false and the groups at the highest level will be nested.
-
Field Summary
Fields Modifier and Type Field Description static charConvertTypeCodeThe char returned from ConvertType.getCodeEx().static charGenerateExistsCodeThe char returned from GenerateExists.getCodeEx().static charPrecalculateObjectDefinitionCodeThe char returned from PrecalculateObjectDefinition.getCodeEx().static charSimplifyTypeCodeThe char returned from SimplifyType.getCodeEx().static charUseExplicitAndForIsolationGroupCodeThe char returned from UseExplicitAndForIsolationGroup.getCodeEx().
-
Method Summary
All 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 SecurityClauseTweaksafeValueOf(String value)Helper function to return the SecurityClauseTweak represented byvalue.static SecurityClauseTweakvalueOf(char code)Helper function to return the SecurityClauseTweak represented by code.static SecurityClauseTweakvalueOf(Character code)Helper function to return the SecurityClauseTweak represented by code.static SecurityClauseTweakvalueOf(String name)Returns the enum constant of this type with the specified name.static SecurityClauseTweakvalueOfCode(String code)Helper function to return the SecurityClauseTweak represented by code.static SecurityClauseTweak[]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
-
GenerateExists
public static final SecurityClauseTweak GenerateExists
Default is true. If set to false, IN-clauses will be preferred over EXISTS-clauses.
-
SimplifyType
public static final SecurityClauseTweak SimplifyType
0 = No simplification, reducing nested selects. 1 = default simplification, reducing the number of referenced tables and eliminating unnecessary conditions.
-
UseExplicitAndForIsolationGroup
public static final SecurityClauseTweak UseExplicitAndForIsolationGroup
Default is false and the groups at the highest level will be nested. Set to true to reduce nesting.
-
ConvertType
public static final SecurityClauseTweak ConvertType
0 = default, no conversion. 1 = conversion to DNF form, i.e. an OR of ANDs. 2 = conversion to a DNF form, where the common conditions will be factored out.
-
PrecalculateObjectDefinition
public static final SecurityClauseTweak PrecalculateObjectDefinition
Default is false. If set to true, the UniqueId of the ObjectDefinition will be set in the security clause instead of calculating it with an additional join.
-
-
Field Detail
-
GenerateExistsCode
public static final char GenerateExistsCode
The char returned from GenerateExists.getCodeEx().- See Also:
GenerateExists, Constant Field Values
-
SimplifyTypeCode
public static final char SimplifyTypeCode
The char returned from SimplifyType.getCodeEx().- See Also:
SimplifyType, Constant Field Values
-
UseExplicitAndForIsolationGroupCode
public static final char UseExplicitAndForIsolationGroupCode
The char returned from UseExplicitAndForIsolationGroup.getCodeEx().
-
ConvertTypeCode
public static final char ConvertTypeCode
The char returned from ConvertType.getCodeEx().- See Also:
ConvertType, Constant Field Values
-
PrecalculateObjectDefinitionCode
public static final char PrecalculateObjectDefinitionCode
The char returned from PrecalculateObjectDefinition.getCodeEx().
-
-
Method Detail
-
values
public static SecurityClauseTweak[] 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 (SecurityClauseTweak c : SecurityClauseTweak.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static SecurityClauseTweak 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 SecurityClauseTweak valueOfCode(String code)
Helper function to return the SecurityClauseTweak 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 SecurityClauseTweak- Returns:
- The SecurityClauseTweak corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static SecurityClauseTweak safeValueOf(String value)
Helper function to return the SecurityClauseTweak represented byvalue. Ifvalueis null, or not a valid SecurityClauseTweak 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 SecurityClauseTweak corresponding to
value, or null, ifvalueis null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static SecurityClauseTweak valueOf(Character code)
Helper function to return the SecurityClauseTweak represented by code. If code is null, or not a valid SecurityClauseTweak code then this method will return null.- Parameters:
code- Character that is one of the codes for HandlerAction- Returns:
- The SecurityClauseTweak corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static SecurityClauseTweak valueOf(char code)
Helper function to return the SecurityClauseTweak represented by code. If code is not a valid SecurityClauseTweak code then this method will return null.- Parameters:
code- char that is one of the codes for HandlerAction- Returns:
- The SecurityClauseTweak corresponding to code, or null, if code is not a valid code
-
getCodeEx
public char getCodeEx()
Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
getCodeExin interfaceSchedulerEnumeration<SecurityClauseTweak>- Returns:
- the database code for the enumeration
-
getCodeExValue
public Character getCodeExValue()
Description copied from interface:BaseSchedulerEnumerationReturn the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValuein interfaceBaseSchedulerEnumeration<SecurityClauseTweak,Character>- Returns:
- the enumeration code
-
getCodeExCharacter
public Character getCodeExCharacter()
Description copied from interface:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
getCodeExCharacterin interfaceSchedulerEnumeration<SecurityClauseTweak>- Returns:
- the database code for the enumeration
-
getTranslationKey
public 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 interfaceBaseSchedulerEnumeration<SecurityClauseTweak,Character>- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumerationGet the English name of this enumeration.- Specified by:
getTranslationENin interfaceBaseSchedulerEnumeration<SecurityClauseTweak,Character>- Returns:
- the English name of this enumeration.
-
getDescriptionKey
public 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 interfaceBaseSchedulerEnumeration<SecurityClauseTweak,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:SchedulerEnumerationGet the code that is used to represent this enumeration in the database.- Specified by:
getCodeExStringin interfaceSchedulerEnumeration<SecurityClauseTweak>- Returns:
- the database code for the enumeration
-
-