com.uc4.communication.requests

Class RestartTask

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.RestartTask

public final class RestartTask
extends XMLRequest

Restarts a task.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestartTask.FileTransferRestart Restart setting of FileTransfers.

Constructor Summary

Constructors

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.

Method Summary

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.

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send

Methods inherited from class java.lang.Object

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

Constructor Detail

RestartTask

public RestartTask(int runID)

Creates a new RestartTask request to restart the task with the specified RunID.

Parameters:

runID - RunID of the task which should be restarted

RestartTask

public RestartTask(UC4ObjectName name,
                   UC4ObjectName queue)

Restarts a task from the object definition.

Parameters:

name - Name of the object.

queue - Name of the queue

RestartTask

public RestartTask(int runID,
                   UC4ObjectName queue)

Creates a new RestartTask request to restart the task with the specified RunID.

Parameters:

runID - RunID of the task which should be restarted

queue - Queue

Method Detail

getRestartedRunID

public int getRestartedRunID()

Returns the runID of the restarted task.

Returns:

RunID of the new task or 0 if not successful

getReferenceRunID

public int getReferenceRunID()

Gets the reference RunID.

Returns:

RunID

setReferenceRunID

public void setReferenceRunID(int referenceRunID)

Sets the reference RunID.

Parameters:

referenceRunID - RunID

getFileTransferSetting

public RestartTask.FileTransferRestart getFileTransferSetting()

Returns the file transfer restart setting.

Returns:

Restart setting specific to a FileTransfer (JOBF)

setFileTransferSetting

public void setFileTransferSetting(RestartTask.FileTransferRestart fileTransferSetting)

Sets the file transfer restart settings. Possible values:

• FileTransferRestart.ALL ... Re-transfer all files
• FileTransferRestart.FROM_LAST_POSITION ... Restart the transfer from the last position

Parameters:

fileTransferSetting - setting

getRestartPoint

public java.lang.String getRestartPoint()

Returns the value of the Restart Point field.

Returns:

Restart Point or an empty string if the restart point has not been set.

setRestartPoint

public void setRestartPoint(java.lang.String restartPoint)

Sets the Restart Point on which the Job should continue.

Parameters:

restartPoint - Point

isKeepStartType

public boolean isKeepStartType()

Returns:

Returns true if the start type should be kept

setKeepStartType

public void setKeepStartType(boolean keepStartType)

Sets a flag to decide if the start type of the task should be kept when the task is restarted.

Parameters:

keepStartType - True if the start type should be kept

isWaitForManualRelease

public boolean isWaitForManualRelease()

Returns:

True if the task should wait for manual release

setWaitForManualRelease

public void setWaitForManualRelease(boolean waitForManualRelease)

Sets a flag to let a restarted task what until it is manually released.

Parameters:

waitForManualRelease - True if manual release should be enabled

getTestOptions

public ExecuteTestOptions getTestOptions()

Returns the TestOptions which are used when restarting the task or null if the TestOptions are not set.

Returns:

TestOptions

setTestOptions

public void setTestOptions(ExecuteTestOptions testOptions)

Sets the test options when restarting this task.

Parameters:

testOptions - TestOptions

isRestartAbortedChildrenOnly

public boolean isRestartAbortedChildrenOnly()

Returns:

True if the only aborted children should be restarted

setRestartAbortedChildrenOnly

public void setRestartAbortedChildrenOnly(boolean restartAbortedChildrenOnly)

Sets a flag to restart only aborted children.

Parameters:

restartAbortedChildrenOnly - True if the only aborted children should be restarted

setActivityRestart

public void setActivityRestart()

If this method is called the detail of a task in the activity list is returned.

setArchiveRestart

public void setArchiveRestart()

If this method is called the detail of a task in the statistics is returned.

setExplorerRestart

public void setExplorerRestart()

If this method is called the detail of a task in the Explorer is returned.