Package com.uc4.communication.requests

Class NavigatorCATree

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.NavigatorCATree

All Implemented Interfaces:

Iterable<NavigatorCATree.CustomAttributeNode>

public class NavigatorCATree
extends XMLRequest
implements Iterable<NavigatorCATree.CustomAttributeNode>

Represents the Custom Attributes tree in the activity window navigator.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NavigatorCATree.CustomAttributeLeaf	Represents a leaf in the NavigatorCATree.
static class	NavigatorCATree.CustomAttributeNode	Represents a node in the NavigationCATree.

Constructor Summary

Constructors

Constructor	Description
NavigatorCATree(String attributeName)	Creates a NavigatorCATree request.

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.
Iterator<NavigatorCATree.CustomAttributeNode>	iterator()	Returns an Iterator which can be used to step through the CustomAttributeNode items of the root.
void	setClient(int client)	Sets a specific client as filter for the NavigatorCATree.
int	size()	Returns the number of top level items in the Navigation Custom Attribute 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, isAllowedInClientZero, 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

NavigatorCATree

public NavigatorCATree(String attributeName)

Creates a NavigatorCATree request.

Parameters:

attributeName - Name(key) of the custom attribute specified in the variable UC_CUSTOM_ATTRIBUTES

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<NavigatorCATree.CustomAttributeNode> iterator()

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

Specified by:

iterator in interface Iterable<NavigatorCATree.CustomAttributeNode>

Returns:

Iterator containing CustomAttributeNode

size

public int size()

Returns the number of top level items in the Navigation Custom Attribute Tree.

Returns:

number of CAItem

setClient

public void setClient(int client)

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

Parameters:

client - filter for the NavigatorCATree