public class NotificationMonitor extends XMLRequest implements java.lang.Iterable<NotificationMonitor.CallStatus>
ModifyNotificationMonitor
Modifier and Type | Class and Description |
---|---|
static class |
NotificationMonitor.CallStatus
This inner class represents a row in the calling status table of this notification monitor.
|
static class |
NotificationMonitor.Type
Notification type.
|
Constructor and Description |
---|
NotificationMonitor(int runID)
Creates a new
NotificationMonitor request. |
NotificationMonitor(java.util.List<java.lang.Integer> runIDs)
Creates a new
NotificationMonitor request. |
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.
|
DateTime |
getEscalation()
Returns the date and time on which the Notification escalates.
|
java.lang.String |
getMessage()
Returns the message text of this notification.
|
java.util.List<NotificationMonitor> |
getNotificationMonitors()
Returns a list of NotificationMonitor objects.
|
NotificationMonitor.Type |
getNotificationType()
Returns the type of the notification independent of the logon languge.
|
int |
getParentRunID()
Returns the RunID of the parent or
0 if there is none. |
java.lang.String |
getPriority()
Returns the Priority of the Notification (high, normal, low).
|
int |
getRunID()
Returns the RunID of this notification.
|
protected java.lang.String |
getSrc()
Returns the request source.
|
DateTime |
getStartTime()
Returns the start time of this notification.
|
int |
getStatusCode()
Returns the status of the notification.
|
java.lang.String |
getSubject()
Returns the subject of the message text.
|
java.lang.String |
getTypeText()
Translated type text, for example Email, Message, Request or Alert.
|
protected void |
handleContent(com.uc4.util.XMLDocument doc,
ConnectionAttributes session) |
boolean |
hasComment()
Returns
true if this notification has comments. |
protected boolean |
isAllowedInClientZero()
This method is used internally.
|
java.util.Iterator<NotificationMonitor.CallStatus> |
iterator() |
int |
size()
Returns the number of rows in the calling status table.
|
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
public NotificationMonitor(int runID)
NotificationMonitor
request.runID
- RunID of the CALL task.public NotificationMonitor(java.util.List<java.lang.Integer> runIDs)
NotificationMonitor
request.runIDs
- RunIDs of the CALL tasks.public int getRunID()
public int getParentRunID()
0
if there is none.protected java.lang.String getSrc()
XMLRequest
getSrc
in class XMLRequest
protected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
XMLRequest
createRequest
in class XMLRequest
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the sessionprotected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
handleContent
in class XMLRequest
public int getStatusCode()
Type Alert
Type Request
Type Message
public NotificationMonitor.Type getNotificationType()
getTypeText()
public boolean hasComment()
true
if this notification has comments.
The request GetComments
can be used to get the detail of the comment.public DateTime getEscalation()
public java.lang.String getTypeText()
public java.lang.String getPriority()
public DateTime getStartTime()
public java.lang.String getSubject()
public java.lang.String getMessage()
protected boolean isAllowedInClientZero()
XMLRequest
XMLRequest
is allowed in client 0.
The default implementation returns false
, subclasses may override.isAllowedInClientZero
in class XMLRequest
true
if this request is allowed in client 0, false
otherwisepublic java.util.Iterator<NotificationMonitor.CallStatus> iterator()
iterator
in interface java.lang.Iterable<NotificationMonitor.CallStatus>
public int size()
public java.util.List<NotificationMonitor> getNotificationMonitors()