Enum ExtensionPointVisibilityType
- java.lang.Object
-
- java.lang.Enum<ExtensionPointVisibilityType>
-
- com.redwood.scheduler.api.model.enumeration.ExtensionPointVisibilityType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ExtensionPointVisibilityType,Character>
,SchedulerEnumeration<ExtensionPointVisibilityType>
,Serializable
,Comparable<ExtensionPointVisibilityType>
public enum ExtensionPointVisibilityType extends Enum<ExtensionPointVisibilityType> implements SchedulerEnumeration<ExtensionPointVisibilityType>
The visibilty of he Extension point, indicating who can access it. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Both
Deprecated.This value is no longer used, choose either Internal or External insteadDisabled
Deprecated.This value is no longer used, use the enabled flag on the extension point insteadExternal
The Extension Point is only accessible from an externally.Internal
The Extension Point is only accessible internally.
-
Field Summary
Fields Modifier and Type Field Description static char
BothCode
Deprecated.static char
DisabledCode
Deprecated.static char
ExternalCode
The char returned from External.getCodeEx().static char
InternalCode
The char returned from Internal.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 ExtensionPointVisibilityType
safeValueOf(String value)
Helper function to return the ExtensionPointVisibilityType represented byvalue
.static ExtensionPointVisibilityType
valueOf(char code)
Helper function to return the ExtensionPointVisibilityType represented by code.static ExtensionPointVisibilityType
valueOf(Character code)
Helper function to return the ExtensionPointVisibilityType represented by code.static ExtensionPointVisibilityType
valueOf(String name)
Returns the enum constant of this type with the specified name.static ExtensionPointVisibilityType
valueOfCode(String code)
Helper function to return the ExtensionPointVisibilityType represented by code.static ExtensionPointVisibilityType[]
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
-
Disabled
@Deprecated public static final ExtensionPointVisibilityType Disabled
Deprecated.This value is no longer used, use the enabled flag on the extension point instead(Obsolete) The Extension Point is no accessible by anyone.
-
Internal
public static final ExtensionPointVisibilityType Internal
The Extension Point is only accessible internally.
-
External
public static final ExtensionPointVisibilityType External
The Extension Point is only accessible from an externally.
-
Both
@Deprecated public static final ExtensionPointVisibilityType Both
Deprecated.This value is no longer used, choose either Internal or External instead(Obsolete) The Extension Point is only accessible internally.
-
-
Field Detail
-
DisabledCode
@Deprecated public static final char DisabledCode
Deprecated.The char returned from Disabled.getCodeEx().
-
InternalCode
public static final char InternalCode
The char returned from Internal.getCodeEx().- See Also:
Internal
, Constant Field Values
-
ExternalCode
public static final char ExternalCode
The char returned from External.getCodeEx().- See Also:
External
, Constant Field Values
-
BothCode
@Deprecated public static final char BothCode
Deprecated.The char returned from Both.getCodeEx().
-
-
Method Detail
-
values
public static ExtensionPointVisibilityType[] 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 (ExtensionPointVisibilityType c : ExtensionPointVisibilityType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ExtensionPointVisibilityType 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 ExtensionPointVisibilityType valueOfCode(String code)
Helper function to return the ExtensionPointVisibilityType 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 ExtensionPointVisibilityType- Returns:
- The ExtensionPointVisibilityType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ExtensionPointVisibilityType safeValueOf(String value)
Helper function to return the ExtensionPointVisibilityType represented byvalue
. Ifvalue
is null, or not a valid ExtensionPointVisibilityType 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 ExtensionPointVisibilityType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ExtensionPointVisibilityType valueOf(Character code)
Helper function to return the ExtensionPointVisibilityType represented by code. If code is null, or not a valid ExtensionPointVisibilityType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ExtensionPointVisibilityType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ExtensionPointVisibilityType valueOf(char code)
Helper function to return the ExtensionPointVisibilityType represented by code. If code is not a valid ExtensionPointVisibilityType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ExtensionPointVisibilityType 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<ExtensionPointVisibilityType>
- 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<ExtensionPointVisibilityType,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<ExtensionPointVisibilityType>
- 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<ExtensionPointVisibilityType,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<ExtensionPointVisibilityType,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<ExtensionPointVisibilityType,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<ExtensionPointVisibilityType>
- Returns:
- the database code for the enumeration
-
-