Interface PostRunningActionScriptObject
-
- All Superinterfaces:
RestartableScriptObject
public interface PostRunningActionScriptObject extends RestartableScriptObject
This class provides methods to inspect and set the new final status, and to control restarts of the trigger/action. This class has no properties.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description com.redwood.scheduler.api.model.enumeration.JobStatus
getFinalStatus()
Get the final status of the job.com.redwood.scheduler.api.model.enumeration.JobStatus
getNewStatus()
Get the original final status of the job.com.redwood.scheduler.api.model.enumeration.JobStatus
getOldStatus()
Get the old status of the job, the status that this job was in before the action started.void
setFinalStatus(com.redwood.scheduler.api.model.enumeration.JobStatus newStatus)
Set the final status of the job.-
Methods inherited from interface com.redwood.scheduler.api.scripting.variables.RestartableScriptObject
getFailJobOnError, getForceRestart, getMaximumRestarts, getPersistentMap, getRestartCount, getRestartReason, logRestarts, setFailJobOnError, setForceRestart, setLogRestarts, setMaximumRestarts
-
-
-
-
Method Detail
-
getFinalStatus
com.redwood.scheduler.api.model.enumeration.JobStatus getFinalStatus()
Get the final status of the job.- Returns:
- the final status that the job will be set to after the action completes.
-
setFinalStatus
void setFinalStatus(com.redwood.scheduler.api.model.enumeration.JobStatus newStatus)
Set the final status of the job.- Parameters:
newStatus
- the new final status to set.
-
getOldStatus
com.redwood.scheduler.api.model.enumeration.JobStatus getOldStatus()
Get the old status of the job, the status that this job was in before the action started.- Returns:
- the old status.
-
getNewStatus
com.redwood.scheduler.api.model.enumeration.JobStatus getNewStatus()
Get the original final status of the job. This is the status that the job will go into unless it is changed by aJobFileSearch
or by callingsetFinalStatus(JobStatus)
in e.g. a PostRunningAction. To get the final status of the job taking these into account, callgetFinalStatus()
.- Returns:
- the original final status of the job.
-
-