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 and 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 and Description
NavigatorCATree(String attributeName) Creates a NavigatorCATree request.

Method Summary

Modifier and Type	Method and Description
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

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, showQuarantineNotification

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

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 Detail

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