Package com.uc4.api.objects

Class NotificationAttributes

java.lang.Object
com.uc4.api.objects.NotificationAttributes
public class NotificationAttributes extends Object
Notification attributes.

  • Constructor Details

    • NotificationAttributes

      protected NotificationAttributes(com.uc4.util.XMLDocument doc)

  • Method Details

    • store

      protected void store(com.uc4.util.XMLDocument doc, Element request)

    • getQueue

      public UC4ObjectName getQueue()
      Returns the Queue Object.
      Returns:
      Name of the Queue Object

    • setQueue

      public void setQueue(UC4ObjectName queue)
      Sets the Queue that will be used when this object is executed.
      Parameters:
      queue - Name of the Queue Object

    • getEscalationMinutes

      public int getEscalationMinutes()
      Returns the time limit in minutes.
      Returns:
      Time limit

    • setEscalationMinutes

      public void setEscalationMinutes(int escalationMinutes)
      Sets the time limit, in minutes, in which the controlling operator has to respond.
      Parameters:
      escalationMinutes - Time limit in minutes

    • getEscalationCallOperator

      public UC4ObjectName getEscalationCallOperator()
      Returns the escalation Notification.
      Returns:
      escalation Notification

    • setEscalationCallOperator

      public void setEscalationCallOperator(UC4ObjectName escalationCallOperator)
      Sets an additional Notification which will be activated if the controlling operator does not respond.
      Parameters:
      escalationCallOperator - Notification

    • isAutoDeactivation

      public boolean isAutoDeactivation()
      Returns true if automatic deactivation of the predecessor is enabled.
      Returns:
      True if automatic deactivation of the predecessor is enabled

    • setAutoDeactivation

      public void setAutoDeactivation(boolean autoDeactivation)
      Enables or disables the automatic deactivation of the predecessor. If selected, an escalated CallOperator automatically closes its predecessor with the status ENDED_ESCALATED.
      Parameters:
      autoDeactivation - Boolean to enable or disable automatic deactivation

    • isSendEmail

      public boolean isSendEmail()
      Returns true if e-mails are sent to the responsible operators at CallOperator start.
      Returns:
      Boolean value containing true if an e-mail is sent at CallOperator start

    • setSendEmail

      public void setSendEmail(boolean sendEmail)
      Enables or disables sending of emails. if sendEmail is set to true e-mails are also sent to the responsible operators at CallOperator start. Two e-mail addresses may be specified in User objects. E-mails are then sent to both addresses.
      Parameters:
      sendEmail - Boolean value to enable or disable email

    • isSnmp

      public boolean isSnmp()
      Returns true if SNMP is enabled.
      Returns:
      True if an SNMP Trap should also be created when this CallOperator starts

    • setSnmp

      public void setSnmp(boolean snmp)
      Enables or disables SNMP. If enabled an SNMP Trap should also be created when this CallOperator starts.
      Parameters:
      snmp - Boolean value to enable or disable SNMP Traps

    • getStartType

      public UC4ObjectName getStartType()
      Returns the start type of this Notification.
      Returns:
      Start type

    • setStartType

      public void setStartType(UC4ObjectName startType)
      Sets the start type of this Notification.
      Parameters:
      startType - Start type

    • getIntAccount

      public String getIntAccount()
      Returns the internal account assigned to this Notification.
      Returns:
      Internal account

    • setIntAccount

      public void setIntAccount(String intAccount)
      Sets the internal account, max. 20 characters.
      Parameters:
      intAccount - Internal account

    • getPriority

      public int getPriority()
      Priority with which this Notification should be executed in the Automation Engine. Permitted values: 0 to 255
      Default: 0
      1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.
      Returns:
      priority

    • setPriority

      public void setPriority(int priority)
      Priority with which this Notification should be executed in the Automation Engine. Permitted values: 0 to 255
      Default: 0
      1 stands for highest, 255 for lowest priority. If 0 is chosen, the priority defined in the UC_CLIENT_SETTINGS variables with TASK_PRIORITY for local clients is used. If no default priority is set or if no variable is present in the local clients, then 200 is assigned as the valid priority.
      Parameters:
      priority - Priority

    • setCallPriorityLow

      public void setCallPriorityLow()
      Sets the Notification priority to low.

    • setCallPriorityMedium

      public void setCallPriorityMedium()
      Sets the Notification priority to medium.

    • setCallPriorityHigh

      public void setCallPriorityHigh()
      Sets the Notification priority to high.

    • isCallPriorityLow

      public boolean isCallPriorityLow()
      Returns true if the Notification priority is low.
      Returns:
      True if Notification priority is low

    • isCallPriorityMedium

      public boolean isCallPriorityMedium()
      Returns true if the Notification priority is medium.
      Returns:
      True if Notification priority is medium

    • isCallPriorityHigh

      public boolean isCallPriorityHigh()
      Returns true if the Notification priority is high.
      Returns:
      True if Notification priority is high

    • setTypeRequest

      public void setTypeRequest()
      Selects the type "Request" for this Notification.

    • setTypeAlarm

      public void setTypeAlarm()
      Selects the type "Alarm" for this Notification.

    • setTypeEmail

      public void setTypeEmail()
      Selects the type "Email" for this Notification.

    • setTypeMessage

      public void setTypeMessage()
      Selects the type "Message" for this Notification.

    • isTypeRequest

      public boolean isTypeRequest()
      Returns true if this Notification has type "Request".
      Returns:
      True if type is set to "Request"

    • isTypeAlarm

      public boolean isTypeAlarm()
      Returns true if this Notification has type "Alarm".
      Returns:
      True if type is set to "Alarm"

    • isTypeEmail

      public boolean isTypeEmail()
      Returns true if this Notification has type "Email".
      Returns:
      True if type is set to "Email"

    • isTypeMessage

      public boolean isTypeMessage()
      Returns true if this Notification has type "Message".
      Returns:
      True if type is set to "Message"

    • isGenerateAtRuntime

      public boolean isGenerateAtRuntime()
      Returns true if this Notification should not be generated at activation time but rather at runtime.
      Returns:
      True if this object is generated at runtime

    • setGenerateAtRuntime

      public void setGenerateAtRuntime(boolean generateAtRuntime)
      Sets if this Notification should be generated at runtime.
      Parameters:
      generateAtRuntime - If set to true the object is generated at runtime

    • getTimezone

      public UC4TimezoneName getTimezone()
      Returns the TimeZone that is to be used.
      Returns:
      TimeZone

    • setTimezone

      public void setTimezone(UC4TimezoneName timezone)
      Sets the TimeZone for this Notification.
      Parameters:
      timezone - TimeZone

    • maxParallel

      public MaxParallel maxParallel()
      Returns settings for parallel tasks.
      Returns:
      parallel task settings

    • getDeactivate

      public DeactivateCondition getDeactivate()
      Returns the deactivate condition for this Job.
      Returns:
      Deactivate condition

    • setDeactivate

      public void setDeactivate(DeactivateCondition deactivate)
      Sets the deactivate condition for this Job.
      Parameters:
      deactivate - Deactivate condition

    • getExtendedReports

      public ExtendedReports getExtendedReports()
      Returns the setting for extended reports.
      Returns:
      Extended reports.

    • setExtendedReports

      public void setExtendedReports(ExtendedReports extendedReports)
      Sets the option for extended reports.
      Parameters:
      extendedReports - Extended reports.