com.uc4.communication.requests

Class ScheduleMonitor

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ScheduleMonitor

All Implemented Interfaces:

java.lang.Iterable<ScheduleMonitor.Task>

public class ScheduleMonitor
extends XMLRequest
implements java.lang.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, boolean active) Constructs a new ScheduleMonitor request.

Method Summary

Methods

Modifier and Type	Method and Description
int	getRunID() Returns the run id of this schedule.
int	getStatusCode() Returns the status of the task as integer.
boolean	isReloadNextTurnaround() Returns true if reload definition at period turnaround is enabled.
java.util.Iterator<ScheduleMonitor.Task>	iterator()
int	size() Returns the number of tasks in this schedule.

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

getMessageBox, getRequestID, handleResponse, send

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduleMonitor

public ScheduleMonitor(int runID,
               boolean active)

Constructs a new ScheduleMonitor request.

Parameters:

runID - RunID

active - true if the monitor should be read from the activity window,

Method Detail

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()

iterator

public java.util.Iterator<ScheduleMonitor.Task> iterator()

Specified by:

iterator in interface java.lang.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