public final class RestartTask extends XMLRequest
Modifier and Type | Class and Description |
---|---|
static class |
RestartTask.FileTransferRestart
Restart setting of FileTransfers.
|
Constructor and Description |
---|
RestartTask(int runID)
Creates a new
RestartTask request to restart the
task with the specified RunID. |
RestartTask(int runID,
UC4ObjectName queue)
Creates a new
RestartTask request to restart the
task with the specified RunID. |
RestartTask(UC4ObjectName name,
UC4ObjectName queue)
Restarts a task from the object definition.
|
Modifier and Type | Method and Description |
---|---|
RestartTask.FileTransferRestart |
getFileTransferSetting()
Returns the file transfer restart setting.
|
int |
getReferenceRunID()
Gets the reference RunID.
|
int |
getRestartedRunID()
Returns the runID of the restarted task.
|
java.lang.String |
getRestartPoint()
Returns the value of the Restart Point field.
|
ExecuteTestOptions |
getTestOptions()
Returns the
TestOptions which are used when restarting
the task or null if the TestOptions are not set. |
boolean |
isKeepStartType() |
boolean |
isRestartAbortedChildrenOnly() |
boolean |
isWaitForManualRelease() |
void |
setActivityRestart()
If this method is called the detail of a task in the activity list is returned.
|
void |
setArchiveRestart()
If this method is called the detail of a task in the statistics is returned.
|
void |
setExplorerRestart()
If this method is called the detail of a task in the Explorer is returned.
|
void |
setFileTransferSetting(RestartTask.FileTransferRestart fileTransferSetting)
Sets the file transfer restart settings.
|
void |
setKeepStartType(boolean keepStartType)
Sets a flag to decide if the start type of the task should be kept when
the task is restarted.
|
void |
setReferenceRunID(int referenceRunID)
Sets the reference RunID.
|
void |
setRestartAbortedChildrenOnly(boolean restartAbortedChildrenOnly)
Sets a flag to restart only aborted children.
|
void |
setRestartPoint(java.lang.String restartPoint)
Sets the Restart Point on which the Job should continue.
|
void |
setTestOptions(ExecuteTestOptions testOptions)
Sets the test options when restarting this task.
|
void |
setWaitForManualRelease(boolean waitForManualRelease)
Sets a flag to let a restarted task what until it is manually released.
|
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send
public RestartTask(int runID)
RestartTask
request to restart the
task with the specified RunID.runID
- RunID of the task which should be restartedpublic RestartTask(UC4ObjectName name, UC4ObjectName queue)
name
- Name of the object.queue
- Name of the queuepublic RestartTask(int runID, UC4ObjectName queue)
RestartTask
request to restart the
task with the specified RunID.runID
- RunID of the task which should be restartedqueue
- Queuepublic int getRestartedRunID()
0
if not successfulpublic int getReferenceRunID()
public void setReferenceRunID(int referenceRunID)
referenceRunID
- RunIDpublic RestartTask.FileTransferRestart getFileTransferSetting()
public void setFileTransferSetting(RestartTask.FileTransferRestart fileTransferSetting)
fileTransferSetting
- settingpublic java.lang.String getRestartPoint()
public void setRestartPoint(java.lang.String restartPoint)
restartPoint
- Pointpublic boolean isKeepStartType()
public void setKeepStartType(boolean keepStartType)
keepStartType
- True if the start type should be keptpublic boolean isWaitForManualRelease()
public void setWaitForManualRelease(boolean waitForManualRelease)
waitForManualRelease
- True if manual release should be enabledpublic ExecuteTestOptions getTestOptions()
TestOptions
which are used when restarting
the task or null
if the TestOptions
are not set.public void setTestOptions(ExecuteTestOptions testOptions)
testOptions
- TestOptionspublic boolean isRestartAbortedChildrenOnly()
public void setRestartAbortedChildrenOnly(boolean restartAbortedChildrenOnly)
restartAbortedChildrenOnly
- True if the only aborted children should be restartedpublic void setActivityRestart()
public void setArchiveRestart()
public void setExplorerRestart()