com.uc4.communication.requests

Class ScheduleMonitor

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ScheduleMonitor

All Implemented Interfaces:

Iterable<ScheduleMonitor.Task>

public class ScheduleMonitor
extends XMLRequest
implements Iterable<ScheduleMonitor.Task>

Reads a Schedule monitor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduleMonitor.Task This class represents a task in the Schedule monitor.

Constructor Summary

Constructors

Constructor and Description
ScheduleMonitor(int runID) Constructs a new ScheduleMonitor request.
ScheduleMonitor(int runID, boolean active) Deprecated.

Method Summary

Modifier and Type	Method and Description
int	getRunID() Returns the run id of this schedule.
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.
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.

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

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, showQuarantineNotification

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

ScheduleMonitor

@Deprecated
public ScheduleMonitor(int runID,
                                   boolean active)

Deprecated.

Constructs a new ScheduleMonitor request.

Parameters:

runID - RunID

active - 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, setExplorerScheduleMonitor

ScheduleMonitor

public ScheduleMonitor(int runID)

Constructs a new ScheduleMonitor request.

Parameters:

runID - RunID

Method Detail

setIncludeTaskProperties

public void setIncludeTaskProperties(boolean includeTaskProperties)

If this method is set to true, the properties of task are also returned in the monitor. The value should be set to false if the values are not used in order to improve the performance for large Schedule monitor tasks.

Parameters:

includeTaskProperties - true to include properties of each task in the response.

isReloadNextTurnaround

public boolean isReloadNextTurnaround()

Returns true if reload definition at period turnaround is enabled.

Returns:

Reload at period turnaround?

getStatusCode

public int getStatusCode()

Returns the status of the task as integer.

Returns:

Status code or -1 in case of an error. Possible return values are described in the status: AbstractTask.getStatusCode()

isActive

public boolean isActive()

Returns:

true if the if task is active, false otherwise

getStartTime

public String getStartTime()

Returns:

start Time

iterator

public Iterator<ScheduleMonitor.Task> iterator()

Specified by:

iterator in interface Iterable<ScheduleMonitor.Task>

size

public int size()

Returns the number of tasks in this schedule.

Returns:

Task count

getRunID

public int getRunID()

Returns the run id of this schedule.

Returns:

run

setActivityScheduleMonitor

public void setActivityScheduleMonitor()

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

setArchiveScheduleMonitor

public void setArchiveScheduleMonitor()

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

setExplorerScheduleMonitor

public void setExplorerScheduleMonitor()

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