Enum ExecutorOrigin
- java.lang.Object
-
- java.lang.Enum<ExecutorOrigin>
-
- com.redwood.scheduler.api.scripting.variables.ExecutorOrigin
-
- All Implemented Interfaces:
Serializable
,Comparable<ExecutorOrigin>
public enum ExecutorOrigin extends Enum<ExecutorOrigin>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ACTION
The execution started within an action.EXTENSIONPOINT
The execution started from an Extension Point.JOB
The execution started within a job.PASSWORDVALIDATING
The execution started with validating a user name and password.PERIODFUNCTION
The execution started within a period function calculator.REL
The execution started within a REL, f.e.RTX
The execution is started by evaluating an RTX REL expression.SERVLET
The execution originated from an external connection.SHELL
The execution started with the evaluation of a script in a shell.TRIGGER
The execution started from a trigger.UI
The execution started from a user performing a UI operation.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isEntityAvailable()
boolean
isExternal()
static ExecutorOrigin
valueOf(String name)
Returns the enum constant of this type with the specified name.static ExecutorOrigin[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
UI
public static final ExecutorOrigin UI
The execution started from a user performing a UI operation. An OriginEntity will not be available
-
TRIGGER
public static final ExecutorOrigin TRIGGER
The execution started from a trigger. The parent ExecutorContext contains the information about the execution triggering the trigger.
-
EXTENSIONPOINT
public static final ExecutorOrigin EXTENSIONPOINT
The execution started from an Extension Point. Keep in mind that an Extension Point might not have a Execution User.
-
JOB
public static final ExecutorOrigin JOB
The execution started within a job.
-
ACTION
public static final ExecutorOrigin ACTION
The execution started within an action. The OriginEntity will point to the Action (JobDefinitionAction, AlertEscalationAction, etc) where this action is defined.
-
SHELL
public static final ExecutorOrigin SHELL
The execution started with the evaluation of a script in a shell.
-
REL
public static final ExecutorOrigin REL
The execution started within a REL, f.e. a DefaultValue provider on a JobDefinitionParameter or PreCondition on a JobDefinition. The OriginEntity will point to the entity where the REL is defined.
-
PERIODFUNCTION
public static final ExecutorOrigin PERIODFUNCTION
The execution started within a period function calculator.
-
RTX
public static final ExecutorOrigin RTX
The execution is started by evaluating an RTX REL expression. The OriginEntity will be either the job this is being called within, or null if not called from within a Job.
-
PASSWORDVALIDATING
public static final ExecutorOrigin PASSWORDVALIDATING
The execution started with validating a user name and password.
-
SERVLET
public static final ExecutorOrigin SERVLET
The execution originated from an external connection.
-
-
Method Detail
-
values
public static ExecutorOrigin[] 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 (ExecutorOrigin c : ExecutorOrigin.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ExecutorOrigin 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
-
isEntityAvailable
public boolean isEntityAvailable()
- Returns:
- Returns if the executorContext has an OriginEntity
-
isExternal
public boolean isExternal()
- Returns:
- Returns true if the origin came from outside the system (Browser, Platform Agent, etc.), or false when it was an internal origin (e.g. Job, Trigger etc.)
-
-