Package com.uc4.communication.requests

Class GroupMonitor

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GroupMonitor

All Implemented Interfaces:

java.lang.Iterable<GroupMonitor.Task>

public class GroupMonitor
extends XMLRequest
implements java.lang.Iterable<GroupMonitor.Task>

Reads a Group monitor.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
GroupMonitor(int runID)	Constructs a new GroupMonitor request.

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.
int	getClient()	Returns the client of the group monitor.
int	getMaxParallelTasks()	Returns the maximum parallel tasks in group
int	getRunID()	Returns the run id of this Group.
protected java.lang.String	getSrc()	Returns the request source.
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.
java.util.Iterator<GroupMonitor.Task>	iterator()
void	setActivityGroupMonitor()	If this method is called the detail of a GroupMonitor in the activity list is returned.
void	setArchiveGroupMonitor()	If this method is called the detail of a GroupMonitor in the statistics is returned.
void	setExplorerGroupMonitor()	If this method is called the detail of a GroupMonitor in the Explorer is returned.
int	size()	Returns the number of tasks in this Group.

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

GroupMonitor

public GroupMonitor(int runID)

Constructs a new GroupMonitor 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

getMaxParallelTasks

public int getMaxParallelTasks()

Returns the maximum parallel tasks in group

Returns:

max parallel tasks

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

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

iterator

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

Specified by:

iterator in interface java.lang.Iterable<GroupMonitor.Task>

size

public int size()

Returns the number of tasks in this Group.

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 Group.

Returns:

run

setActivityGroupMonitor

public void setActivityGroupMonitor()

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

setArchiveGroupMonitor

public void setArchiveGroupMonitor()

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

setExplorerGroupMonitor

public void setExplorerGroupMonitor()

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

getClient

public int getClient()

Returns the client of the group monitor.

Returns:

Client number