Package com.uc4.communication.requests

Class NotificationMonitor

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.NotificationMonitor
All Implemented Interfaces:
Iterable<NotificationMonitor.CallStatus>
public class NotificationMonitor extends XMLRequest implements Iterable<NotificationMonitor.CallStatus>
Reads the monitor of a notification. The modify the notification use the request ModifyNotificationMonitor

  • Constructor Details

    • NotificationMonitor

      public NotificationMonitor(int runID)
      Creates a new NotificationMonitor request.
      Parameters:
      runID - RunID of the CALL task.

    • NotificationMonitor

      public NotificationMonitor(List<Integer> runIDs)
      Creates a new NotificationMonitor request.
      Parameters:
      runIDs - RunIDs of the CALL tasks.

  • Method Details

    • getRunID

      public int getRunID()
      Returns the RunID of this notification.
      Returns:
      RunID

    • getParentRunID

      public int getParentRunID()
      Returns the RunID of the parent or 0 if there is none.
      Returns:
      RunID of the parent

    • getSrc

      protected 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, 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

    • getStatusCode

      public int getStatusCode()
      Returns the status of the notification. This information can be used to restrict the possible actions. For example, enable or disable accept, done and reject button depending on the state.
      Returns:

      Type Alert

      • 1552 Called - possible actions are Accept or Reject
      • 1553 Accepted - possible actions are Done and Reject

      Type Request

      • 1552 Called - possible actions are Yes or No

      Type Message

      • 1552 Called - possible action is Ok

    • getNotificationType

      public NotificationMonitor.Type getNotificationType()
      Returns the type of the notification independent of the logon languge. The translated type text is returned in getTypeText()
      Returns:
      Type

    • hasComment

      public boolean hasComment()
      Returns true if this notification has comments. The request GetComments can be used to get the detail of the comment.
      Returns:
      true if comments are stored

    • getEscalation

      public DateTime getEscalation()
      Returns the date and time on which the Notification escalates. The specified Notification starts if there is no user acknowledgement. A particular point in time is only displayed if a definition was made in the setting "Escalation" of the "Operator" tab.
      Returns:
      DateTime instance, which can be empty but never null

    • getTypeText

      public String getTypeText()
      Translated type text, for example Email, Message, Request or Alert.
      Returns:
      Type of the notification

    • getPriority

      public String getPriority()
      Returns the Priority of the Notification (high, normal, low).
      Returns:
      translated priority, for example "High" (English) or "Hoch" (German)

    • getStartTime

      public DateTime getStartTime()
      Returns the start time of this notification.
      Returns:
      Start time

    • getSubject

      public String getSubject()
      Returns the subject of the message text.
      Returns:
      Subject

    • getMessage

      public String getMessage()
      Returns the message text of this notification.
      Returns:
      Message text

    • 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

    • iterator

      public Iterator<NotificationMonitor.CallStatus> iterator()
      Specified by:
      iterator in interface Iterable<NotificationMonitor.CallStatus>

    • size

      public int size()
      Returns the number of rows in the calling status table.
      Returns:
      Count

    • getNotificationMonitors

      public List<NotificationMonitor> getNotificationMonitors()
      Returns a list of NotificationMonitor objects.
      Returns:
      List of NotificationMonitor, can be empty but never null.