Package 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	Description
static class	ScheduleMonitor.Task	This class represents a task in the Schedule monitor.

Constructor Summary

Constructors

Constructor	Description
ScheduleMonitor(int runID)	Constructs a new ScheduleMonitor request.
ScheduleMonitor(int runID, boolean active)	Deprecated. This method is deprecated on 31-03-2016, please set "src" using methods setActivityScheduleMonitor, setArchiveScheduleMonitor, setExplorerScheduleMonitor

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
protected ScheduleMonitor.Task	createTask(org.w3c.dom.Element task, ConnectionAttributes session)	Creates a new ScheduleMonitor.Task in the Schedule monitor.
int	getRunID()	Returns the run id of this schedule.
protected java.lang.String	getSrc()	Returns the request source.
java.lang.String	getStartTime()
int	getStatusCode()	Returns the status of the task as integer.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
boolean	isActive()
protected boolean	isAllowedInClientZero()	This method is used internally.
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.

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

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, 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.

This method is deprecated on 31-03-2016, please set "src" using methods setActivityScheduleMonitor, setArchiveScheduleMonitor, setExplorerScheduleMonitor

Constructs a new ScheduleMonitor request.

Parameters:

runID - RunID

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

ScheduleMonitor

public ScheduleMonitor(int runID)

Constructs a new ScheduleMonitor request.

Parameters:

runID - RunID

Method Detail

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.Element request,
                             ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

getSrc

protected java.lang.String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

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 java.lang.String getStartTime()

Returns:

start Time

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
                             ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user session

createTask

protected ScheduleMonitor.Task createTask(org.w3c.dom.Element task,
                                          ConnectionAttributes session)

Creates a new ScheduleMonitor.Task in the Schedule monitor. Sub classes may override this method.

Parameters:

task - XML Element of the task

session - Session Info

Returns:

a new ScheduleMonitor.Task instance

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

isAllowedInClientZero

protected boolean isAllowedInClientZero()

Description copied from class: XMLRequest

This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.

Overrides:

isAllowedInClientZero in class XMLRequest

Returns:

true if this request is allowed in client 0, false otherwise

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.