Package com.uc4.api.objects
Class TaskRuntime
java.lang.Object
com.uc4.api.objects.TaskRuntime
- Direct Known Subclasses:
JobPlanMonitor.JobPlanMonitorRuntime
Task runtime.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncopy()
This method is used to return the copy of the TaskRuntime Object.Returns the object which is executed when the runtime exceeds or falls below the specified limits.boolean
Returnstrue
if the exceeding runtime will initiate a cancel or the completion of the task.boolean
Returnstrue
if the task settings should be used.Returns aMaximumRuntime
which can be used to modify the maximum runtime settings.Returns aMinimumRuntime
which can be used to modify the minimum runtime settings.void
setCancelJobAboveMRT
(boolean cancelJobAboveMRT) IfcancelJobAboveMRT
is set totrue
the exceeding runtime will initiate a cancel or the completion of the task.void
setExecuteObject
(UC4ObjectName executeObject) Sets the object which is executed when the runtime exceeds or falls below the specified limits.void
setUseTaskSettings
(boolean useTaskSettings) If the parameteruseTaskSettings
is set tofalse
the methods in this class can be used to set the runtime settings of this task.protected void
-
Constructor Details
-
TaskRuntime
-
-
Method Details
-
isUseTaskSettings
public boolean isUseTaskSettings()Returnstrue
if the task settings should be used.- Returns:
- Boolean which is set to true if task settings should be used
-
setUseTaskSettings
public void setUseTaskSettings(boolean useTaskSettings) If the parameteruseTaskSettings
is set tofalse
the methods in this class can be used to set the runtime settings of this task.- Parameters:
useTaskSettings
- Boolean which is set to true if task settings should be used
-
isCancelJobAboveMRT
public boolean isCancelJobAboveMRT()Returnstrue
if the exceeding runtime will initiate a cancel or the completion of the task. Only available when the maximum runtime is being supervised.- Returns:
- Boolean which is set to true if the object should be canceled when the runtime is exceeded
-
getExecuteObject
Returns the object which is executed when the runtime exceeds or falls below the specified limits. Only available when runtime is being supervised.- Returns:
- UC4ObjectName of the executed object
-
setCancelJobAboveMRT
public void setCancelJobAboveMRT(boolean cancelJobAboveMRT) IfcancelJobAboveMRT
is set totrue
the exceeding runtime will initiate a cancel or the completion of the task.- Parameters:
cancelJobAboveMRT
- Boolean which is set to true if the object should be canceled when the runtime is exceeded
-
maximumRuntime
Returns aMaximumRuntime
which can be used to modify the maximum runtime settings.- Returns:
- MaximumRuntime
-
minimumRuntime
Returns aMinimumRuntime
which can be used to modify the minimum runtime settings.- Returns:
- MinimumRuntime
-
setExecuteObject
Sets the object which is executed when the runtime exceeds or falls below the specified limits. Only available when runtime is being supervised.- Parameters:
executeObject
- UC4ObjectName of the executed object
-
store
-
copy
This method is used to return the copy of the TaskRuntime Object.- Returns:
- TaskRuntime
-