Package com.uc4.communication.requests

Class NavigatorStatusTree

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.NavigatorStatusTree

All Implemented Interfaces:

Iterable<NavigatorStatusTree.StatusNode>

public class NavigatorStatusTree
extends XMLRequest
implements Iterable<NavigatorStatusTree.StatusNode>

Represents the status tree in the activity window navigator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	NavigatorStatusTree.StatusLeaf	Represents a leaf in the NavigatorStatusTree.
class	NavigatorStatusTree.StatusNode	Represents a node in the NavigatorStatusTree.

Constructor Summary

Constructors

Constructor	Description
NavigatorStatusTree()

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
protected String	getSrc()	Returns the request source.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
protected boolean	isAllowedInClientZero()	This method is used internally.
Iterator<NavigatorStatusTree.StatusNode>	iterator()	Returns an Iterator which can be used to step through the StatusNode items of the root.
void	setClient(int client)	Sets a specific client used as filter for the NavigatorStatusTree.
int	size()	Returns the number of top level items in the Navigation Status Tree.

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 Details

NavigatorStatusTree

public NavigatorStatusTree()

Method Details

getSrc

protected String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
 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

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 Iterator<NavigatorStatusTree.StatusNode> iterator()

Returns an Iterator which can be used to step through the StatusNode items of the root.

Specified by:

iterator in interface Iterable<NavigatorStatusTree.StatusNode>

Returns:

Iterator containing StatusNode

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

size

public int size()

Returns the number of top level items in the Navigation Status Tree.

Returns:

number of QueueItem

setClient

public void setClient(int client)

Sets a specific client used as filter for the NavigatorStatusTree. This method is only used for client 0. For all clients other 0 it has no effect.

Parameters:

client - filter for the NavigatorStatusTree