Package com.uc4.communication.requests
Class NavigatorAgentTree
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.NavigatorAgentTree
- All Implemented Interfaces:
Iterable<NavigatorAgentTree.AgentNode>
public class NavigatorAgentTree
extends XMLRequest
implements Iterable<NavigatorAgentTree.AgentNode>
Represents the agent tree in the activity window navigator.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Represents a leaf in theNavigatorAgentTree
.static class
Represents a node in theNavigatorAgentTree
. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected 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
This method is used internally.iterator()
Returns an Iterator which can be used to step through theAgentNode
items of the root.void
setClient
(int client) Sets a specific client as filter for theNavigatorAgentTree
.int
size()
Returns the number of top level items in the Navigation Queue 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
-
NavigatorAgentTree
public NavigatorAgentTree()
-
-
Method Details
-
getSrc
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- 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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the session
-
handleContent
Description copied from class:XMLRequest
Sub classes extract the values from the XML document and provide public getter methods.- Overrides:
handleContent
in classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
iterator
Returns an Iterator which can be used to step through theAgentNode
items of the root.- Specified by:
iterator
in interfaceIterable<NavigatorAgentTree.AgentNode>
- Returns:
- Iterator containing
AgentNode
-
isAllowedInClientZero
protected boolean isAllowedInClientZero()Description copied from class:XMLRequest
This method is used internally. Tests if thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- 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 Queue Tree.- Returns:
- number of
QueueItem
-
setClient
public void setClient(int client) Sets a specific client as filter for theNavigatorAgentTree
. This method is only used for client 0. For all clients other 0 it has no effect.- Parameters:
client
- filter for theNavigatorAgentTree
-