com.uc4.communication.requests

Class QueueList

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.QueueList

All Implemented Interfaces:

java.lang.Iterable<QueueListItem>

public class QueueList
extends XMLRequest
implements java.lang.Iterable<QueueListItem>

Returns the list of Queue.

Constructor Summary

Constructors

Constructor and Description
QueueList()

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<QueueListItem>	iterator() Returns an Iterator which can be used to step through the QueueListItem.
int	size() Returns the total number of items in the Queue list (active and inactive).

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

QueueList

public QueueList()

Method Detail

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

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

iterator

public java.util.Iterator<QueueListItem> iterator()

Returns an Iterator which can be used to step through the QueueListItem. If this class does not contain a client list this method returns null

Specified by:

iterator in interface java.lang.Iterable<QueueListItem>

Returns:

Iterator containing QueueListItem or null in case of an error

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 total number of items in the Queue list (active and inactive).

Returns:

number of QueueListItem