com.uc4.api.objects

Class TaskRuntime

java.lang.Object

com.uc4.api.objects.TaskRuntime

Direct Known Subclasses:

JobPlanMonitor.JobPlanMonitorRuntime

public class TaskRuntime
extends java.lang.Object

Task runtime.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TaskRuntime(com.uc4.util.XMLDocument doc, org.w3c.dom.Element task)

Method Summary

Modifier and Type	Method and Description
TaskRuntime	copy() This method is used to return the copy of the TaskRuntime Object.
UC4ObjectName	getExecuteObject() Returns the object which is executed when the runtime exceeds or falls below the specified limits.
boolean	isCancelJobAboveMRT() Returns true if the exceeding runtime will initiate a cancel or the completion of the task.
boolean	isUseTaskSettings() Returns true if the task settings should be used.
MaximumRuntime	maximumRuntime() Returns a MaximumRuntime which can be used to modify the maximum runtime settings.
MinimumRuntime	minimumRuntime() Returns a MinimumRuntime which can be used to modify the minimum runtime settings.
void	setCancelJobAboveMRT(boolean cancelJobAboveMRT) If cancelJobAboveMRT is set to true 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 parameter useTaskSettings is set to false the methods in this class can be used to set the runtime settings of this task.
protected void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element task)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskRuntime

protected TaskRuntime(com.uc4.util.XMLDocument doc,
                      org.w3c.dom.Element task)

Method Detail

isUseTaskSettings

public boolean isUseTaskSettings()

Returns true 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 parameter useTaskSettings is set to false 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()

Returns true 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

public UC4ObjectName 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)

If cancelJobAboveMRT is set to true 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

public MaximumRuntime maximumRuntime()

Returns a MaximumRuntime which can be used to modify the maximum runtime settings.

Returns:

MaximumRuntime

minimumRuntime

public MinimumRuntime minimumRuntime()

Returns a MinimumRuntime which can be used to modify the minimum runtime settings.

Returns:

MinimumRuntime

setExecuteObject

public void setExecuteObject(UC4ObjectName executeObject)

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

protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element task)

copy

public TaskRuntime copy()

This method is used to return the copy of the TaskRuntime Object.

Returns:

TaskRuntime