Package com.uc4.communication.requests

Class NotificationState

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.NotificationState

public class NotificationState
extends XMLRequest

Finds the highest Notification priority for current user.

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	NONE
protected int	state

Constructor Summary

Constructors

Constructor	Description
NotificationState()

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.
boolean	hasNotification()	Indicates if there is an open Notification for this user or usergroup.
protected boolean	isAllowedInClientZero()	This method is used internally.
boolean	isPriorityHigh()	Returns true if a Notification with high priority exists for this user.
boolean	isPriorityLow()	Returns true if a Notification with low priority exists for this user.
boolean	isPriorityMedium()	Returns true if a Notification with medium priority exists for this user.

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

Field Detail

NONE

protected static final int NONE

See Also:

Constant Field Values

state

protected int state

Constructor Detail

NotificationState

public NotificationState()

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

isPriorityHigh

public boolean isPriorityHigh()

Returns true if a Notification with high priority exists for this user.

Returns:

Boolean which is set to true if an unanswered high priority Notification exists for this user in the current client

isPriorityMedium

public boolean isPriorityMedium()

Returns true if a Notification with medium priority exists for this user. This method returns false if there is an open high priority Notification.

Returns:

Boolean which is set to true if an unanswered medium priority Notification exists for this user in the current client

isPriorityLow

public boolean isPriorityLow()

Returns true if a Notification with low priority exists for this user. This method returns false if there are Notifications with high or medium priority.

Returns:

Boolean which is set to true if an unanswered low priority Notification exists for this user in the current client

hasNotification

public boolean hasNotification()

Indicates if there is an open Notification for this user or usergroup. The methods isPriorityHigh, isPriorityMedium and isPriorityLow can be used to determine the Notification priority. If this method returns false none of the above methods will return true.

Returns:

Boolean which is set to true if an unanswered Notification exists for this user in the current client

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