Enum JobDefinitionActionType
- java.lang.Object
-
- java.lang.Enum<JobDefinitionActionType>
-
- com.redwood.scheduler.api.model.enumeration.JobDefinitionActionType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<JobDefinitionActionType,Character>
,SchedulerEnumeration<JobDefinitionActionType>
,Serializable
,Comparable<JobDefinitionActionType>
public enum JobDefinitionActionType extends Enum<JobDefinitionActionType> implements SchedulerEnumeration<JobDefinitionActionType>
When an action should run. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description OnBeforeJobUserChange
The action executes when a user changes a process of this ProcessDefinition (user persist).OnChange
The action executes during process to process status change prior to pre running.OnJobFileContentAccess
The action executes when a user attempts to access the file content.OnUserMessageOperation
The action executes for User Message process definitions when user operations are performed, e.g.PostRunning
The action executes when the process finishes.PreRunning
The action executes immediately prior to the process starting to run.
-
Field Summary
Fields Modifier and Type Field Description static char
OnBeforeJobUserChangeCode
The char returned from OnBeforeJobUserChange.getCodeEx().static char
OnChangeCode
The char returned from OnChange.getCodeEx().static char
OnJobFileContentAccessCode
The char returned from OnJobFileContentAccess.getCodeEx().static char
OnUserMessageOperationCode
The char returned from OnUserMessageOperation.getCodeEx().static char
PostRunningCode
The char returned from PostRunning.getCodeEx().static char
PreRunningCode
The char returned from PreRunning.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
getContextObjectName()
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 JobDefinitionActionType
safeValueOf(String value)
Helper function to return the JobDefinitionActionType represented byvalue
.static JobDefinitionActionType
valueOf(char code)
Helper function to return the JobDefinitionActionType represented by code.static JobDefinitionActionType
valueOf(Character code)
Helper function to return the JobDefinitionActionType represented by code.static JobDefinitionActionType
valueOf(String name)
Returns the enum constant of this type with the specified name.static JobDefinitionActionType
valueOfCode(String code)
Helper function to return the JobDefinitionActionType represented by code.static JobDefinitionActionType[]
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
-
OnChange
public static final JobDefinitionActionType OnChange
The action executes during process to process status change prior to pre running. ie. any status change prior Queued to Dispatched.
-
PreRunning
public static final JobDefinitionActionType PreRunning
The action executes immediately prior to the process starting to run. ie. Queued to Dispatched.
-
PostRunning
public static final JobDefinitionActionType PostRunning
The action executes when the process finishes. ie. Running to a final status.
-
OnUserMessageOperation
public static final JobDefinitionActionType OnUserMessageOperation
The action executes for User Message process definitions when user operations are performed, e.g. forward, delegate, reply.
-
OnBeforeJobUserChange
public static final JobDefinitionActionType OnBeforeJobUserChange
The action executes when a user changes a process of this ProcessDefinition (user persist).
-
OnJobFileContentAccess
public static final JobDefinitionActionType OnJobFileContentAccess
The action executes when a user attempts to access the file content.
-
-
Field Detail
-
OnChangeCode
public static final char OnChangeCode
The char returned from OnChange.getCodeEx().- See Also:
OnChange
, Constant Field Values
-
PreRunningCode
public static final char PreRunningCode
The char returned from PreRunning.getCodeEx().- See Also:
PreRunning
, Constant Field Values
-
PostRunningCode
public static final char PostRunningCode
The char returned from PostRunning.getCodeEx().- See Also:
PostRunning
, Constant Field Values
-
OnUserMessageOperationCode
public static final char OnUserMessageOperationCode
The char returned from OnUserMessageOperation.getCodeEx().- See Also:
OnUserMessageOperation
, Constant Field Values
-
OnBeforeJobUserChangeCode
public static final char OnBeforeJobUserChangeCode
The char returned from OnBeforeJobUserChange.getCodeEx().- See Also:
OnBeforeJobUserChange
, Constant Field Values
-
OnJobFileContentAccessCode
public static final char OnJobFileContentAccessCode
The char returned from OnJobFileContentAccess.getCodeEx().- See Also:
OnJobFileContentAccess
, Constant Field Values
-
-
Method Detail
-
values
public static JobDefinitionActionType[] 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 (JobDefinitionActionType c : JobDefinitionActionType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static JobDefinitionActionType 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
-
getContextObjectName
public String getContextObjectName()
-
valueOfCode
public static JobDefinitionActionType valueOfCode(String code)
Helper function to return the JobDefinitionActionType 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 JobDefinitionActionType- Returns:
- The JobDefinitionActionType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static JobDefinitionActionType safeValueOf(String value)
Helper function to return the JobDefinitionActionType represented byvalue
. Ifvalue
is null, or not a valid JobDefinitionActionType 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 JobDefinitionActionType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static JobDefinitionActionType valueOf(Character code)
Helper function to return the JobDefinitionActionType represented by code. If code is null, or not a valid JobDefinitionActionType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The JobDefinitionActionType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static JobDefinitionActionType valueOf(char code)
Helper function to return the JobDefinitionActionType represented by code. If code is not a valid JobDefinitionActionType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The JobDefinitionActionType 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<JobDefinitionActionType>
- 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<JobDefinitionActionType,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<JobDefinitionActionType>
- 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<JobDefinitionActionType,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<JobDefinitionActionType,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<JobDefinitionActionType,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<JobDefinitionActionType>
- Returns:
- the database code for the enumeration
-
-