Platform SDK Java 8.5 API Reference

com.genesyslab.platform.reporting.protocol.statserver
Class Notification

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.runtime.CompoundValue
          extended by com.genesyslab.platform.reporting.protocol.statserver.Notification
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class Notification
extends com.genesyslab.platform.commons.protocol.runtime.CompoundValue


Constructor Summary
Notification()
           
 
Method Summary
static Notification create()
          Creates instance of Notification with no parameters set.
static Notification create(NotificationMode mode, java.lang.Integer frequency, java.lang.Integer insensitivity)
          Creates instance of Notification with all parameters set.
abstract  java.lang.Integer getFrequency()
          For time-based notification mode, this value specifies the notification frequency in seconds.
abstract  java.lang.Integer getInsensitivity()
          For change-based notification mode, Stat Server only reports the recalculated value of a statistic if the absolute value of the difference between the previous value and the recalculated value or its percentage ratio to recalculated value is at least equal to the integer specified by insensitivity.
abstract  NotificationMode getMode()
          Indicates the notification mode (Immediate, Periodical, NoNotification, or Reset) of a statistic.
abstract  void setFrequency(int frequency)
          For time-based notification mode, this value specifies the notification frequency in seconds.
abstract  void setFrequency(java.lang.Integer frequency)
          For time-based notification mode, this value specifies the notification frequency in seconds.
abstract  void setInsensitivity(int insensitivity)
          For change-based notification mode, Stat Server only reports the recalculated value of a statistic if the absolute value of the difference between the previous value and the recalculated value or its percentage ratio to recalculated value is at least equal to the integer specified by insensitivity.
abstract  void setInsensitivity(java.lang.Integer insensitivity)
          For change-based notification mode, Stat Server only reports the recalculated value of a statistic if the absolute value of the difference between the previous value and the recalculated value or its percentage ratio to recalculated value is at least equal to the integer specified by insensitivity.
abstract  void setMode(NotificationMode mode)
          Indicates the notification mode (Immediate, Periodical, NoNotification, or Reset) of a statistic.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.runtime.CompoundValue
getProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Notification

public Notification()
Method Detail

create

public static Notification create()
Creates instance of Notification with no parameters set.

Returns:
instance of Notification

create

public static Notification create(NotificationMode mode,
                                  java.lang.Integer frequency,
                                  java.lang.Integer insensitivity)
Creates instance of Notification with all parameters set.

Parameters:
mode - Mode
frequency - Frequency
insensitivity - Insensitivity
Returns:
instance of Notification

getMode

public abstract NotificationMode getMode()
Indicates the notification mode (Immediate, Periodical, NoNotification, or Reset) of a statistic.


setMode

public abstract void setMode(NotificationMode mode)
Indicates the notification mode (Immediate, Periodical, NoNotification, or Reset) of a statistic.


getFrequency

public abstract java.lang.Integer getFrequency()
For time-based notification mode, this value specifies the notification frequency in seconds. If NotificationMode is set to Periodical, then this value is also used as Insensitivity.


setFrequency

public abstract void setFrequency(java.lang.Integer frequency)
For time-based notification mode, this value specifies the notification frequency in seconds. If NotificationMode is set to Periodical, then this value is also used as Insensitivity.


setFrequency

public abstract void setFrequency(int frequency)
For time-based notification mode, this value specifies the notification frequency in seconds. If NotificationMode is set to Periodical, then this value is also used as Insensitivity.


getInsensitivity

public abstract java.lang.Integer getInsensitivity()
For change-based notification mode, Stat Server only reports the recalculated value of a statistic if the absolute value of the difference between the previous value and the recalculated value or its percentage ratio to recalculated value is at least equal to the integer specified by insensitivity. (Note: This value is not used when NotificationMode is set to Periodical.)


setInsensitivity

public abstract void setInsensitivity(java.lang.Integer insensitivity)
For change-based notification mode, Stat Server only reports the recalculated value of a statistic if the absolute value of the difference between the previous value and the recalculated value or its percentage ratio to recalculated value is at least equal to the integer specified by insensitivity. (Note: This value is not used when NotificationMode is set to Periodical.)


setInsensitivity

public abstract void setInsensitivity(int insensitivity)
For change-based notification mode, Stat Server only reports the recalculated value of a statistic if the absolute value of the difference between the previous value and the recalculated value or its percentage ratio to recalculated value is at least equal to the integer specified by insensitivity. (Note: This value is not used when NotificationMode is set to Periodical.)


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.