com.uc4.communication.requests

Class AgentAndGroupList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.AgentAndGroupList

All Implemented Interfaces:

java.lang.Iterable<AgentAndGroupList.AgentOrGroupListItem>

public class AgentAndGroupList
extends XMLRequest
implements java.lang.Iterable<AgentAndGroupList.AgentOrGroupListItem>

Retrieves a list of agents and agentgroups in the current client matching the specified filter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentAndGroupList.AgentAndGroupListFilter Cut the result of the list by using this filter.
static class	AgentAndGroupList.AgentOrGroupListItem Represents an agent or an agentgroup in the list.

Constructor Summary

Constructors

Constructor and Description
AgentAndGroupList(AgentAndGroupList.AgentAndGroupListFilter filter) Constructs a list with a filter.

Method Summary

Modifier and Type	Method and Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.
protected java.lang.String	getSrc() Returns the request source.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
protected boolean	isAllowedInClientZero() This method is used internally.
java.util.Iterator<AgentAndGroupList.AgentOrGroupListItem>	iterator()
int	size() Returns the number of resulting items in the list.

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

AgentAndGroupList

public AgentAndGroupList(AgentAndGroupList.AgentAndGroupListFilter filter)

Constructs a list with a filter.

Parameters:

filter - must not be null.

Method Detail

iterator

public java.util.Iterator<AgentAndGroupList.AgentOrGroupListItem> iterator()

Specified by:

iterator in interface java.lang.Iterable<AgentAndGroupList.AgentOrGroupListItem>

size

public int size()

Returns the number of resulting items in the list.

Returns:

size of list

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

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

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

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
                             ConnectionAttributes session)

Overrides:

handleContent in class XMLRequest