public class ScheduleMonitor extends XMLRequest implements java.lang.Iterable<ScheduleMonitor.Task>
Modifier and Type | Class and Description |
---|---|
static class |
ScheduleMonitor.Task
This class represents a task in the Schedule monitor.
|
Constructor and Description |
---|
ScheduleMonitor(int runID)
Constructs a new
ScheduleMonitor request. |
ScheduleMonitor(int runID,
boolean active)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
int |
getRunID()
Returns the run id of this schedule.
|
java.lang.String |
getStartTime() |
int |
getStatusCode()
Returns the status of the task as integer.
|
boolean |
isActive() |
boolean |
isReloadNextTurnaround()
Returns
true if reload definition at period turnaround is
enabled. |
java.util.Iterator<ScheduleMonitor.Task> |
iterator() |
void |
setActivityScheduleMonitor()
If this method is called the detail of a ScheduleMonitor in the activity list is returned.
|
void |
setArchiveScheduleMonitor()
If this method is called the detail of a ScheduleMonitor in the statistics is returned.
|
void |
setExplorerScheduleMonitor()
If this method is called the detail of a ScheduleMonitor in the Explorer is returned.
|
void |
setIncludeTaskProperties(boolean includeTaskProperties)
If this method is set to true, the properties of task are also returned
in the monitor.
|
int |
size()
Returns the number of tasks in this schedule.
|
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send
@Deprecated public ScheduleMonitor(int runID, boolean active)
ScheduleMonitor
request.runID
- RunIDactive
- true if the monitor should be read from the activity window,
This method is deprecated on 31-03-2016,
please set "src" using methods
setActivityScheduleMonitor, setArchiveScheduleMonitor, setExplorerScheduleMonitorpublic ScheduleMonitor(int runID)
ScheduleMonitor
request.runID
- RunIDpublic void setIncludeTaskProperties(boolean includeTaskProperties)
includeTaskProperties
- true to include properties of each task in the response.public boolean isReloadNextTurnaround()
true
if reload definition at period turnaround is
enabled.public int getStatusCode()
-1
in case of an error. Possible return values are described in the status: AbstractTask.getStatusCode()
public boolean isActive()
public java.lang.String getStartTime()
public java.util.Iterator<ScheduleMonitor.Task> iterator()
iterator
in interface java.lang.Iterable<ScheduleMonitor.Task>
public int size()
public int getRunID()
public void setActivityScheduleMonitor()
public void setArchiveScheduleMonitor()
public void setExplorerScheduleMonitor()