Package com.uc4.communication.requests

Class ActiveNotifications

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.ActiveNotifications

All Implemented Interfaces:

java.lang.Iterable<ActiveNotifications.Entry>

public class ActiveNotifications
extends XMLRequest
implements java.lang.Iterable<ActiveNotifications.Entry>

Returns a list of active notifications.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ActiveNotifications.Entry	This class represents a row in the table of active notifications.

Constructor Summary

Constructors

Constructor	Description
ActiveNotifications()

Method Summary

Modifier and Type	Method	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)	Sub classes extract the values from the XML document and provide public getter methods.
java.util.Iterator<ActiveNotifications.Entry>	iterator()
int	size()	Returns the number of active notifications.

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 Detail

ActiveNotifications

public ActiveNotifications()

Method Detail

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

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)

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

size

public int size()

Returns the number of active notifications.

Returns:

Notification count

iterator

public java.util.Iterator<ActiveNotifications.Entry> iterator()

Specified by:

iterator in interface java.lang.Iterable<ActiveNotifications.Entry>