public final class ModifyStartTime extends XMLRequest
Constructor and Description |
---|
ModifyStartTime(int runID,
DateTime start,
DateTime logicalDatetime,
UC4TimezoneName timeZone)
Constructs a new
ModifyStartTime request to change
the start time of a task. |
ModifyStartTime(int runID,
DateTime start,
UC4TimezoneName timeZone)
Constructs a new
ModifyStartTime request to change
the start time of a task. |
Modifier and Type | Method and Description |
---|---|
boolean |
isTimeoutIfPast()
Returns
true if the task should end with a timeout in case the modified start date is in the past, false
is returned if the task should start immediately. |
void |
modifyFirstTimeExecuteTask()
This method will set the timeoutIfPast to Zero.
|
void |
setTimeoutIfPast(boolean timeoutIfPast)
Sets the behaviour in case of a start date which is in the past: If the parameter
timeoutIfPast is set to true the task will
end if false the task will run immediately. |
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send
public ModifyStartTime(int runID, DateTime start, UC4TimezoneName timeZone)
ModifyStartTime
request to change
the start time of a task.runID
- RunID of the taskstart
- Start time New start time of the tasktimeZone
- Name of the time zone object or null if the default should be usedpublic ModifyStartTime(int runID, DateTime start, DateTime logicalDatetime, UC4TimezoneName timeZone)
ModifyStartTime
request to change
the start time of a task.runID
- RunID of the taskstart
- Start time New start time of the tasklogicalDatetime
- logical Date and timetimeZone
- Name of the time zone object or null if the default should be usedpublic boolean isTimeoutIfPast()
true
if the task should end with a timeout in case the modified start date is in the past, false
is returned if the task should start immediately.public void setTimeoutIfPast(boolean timeoutIfPast)
timeoutIfPast
is set to true
the task will
end if false
the task will run immediately.timeoutIfPast
- Timeout if modification is in pastpublic void modifyFirstTimeExecuteTask()