Platform SDK Java 8.5 API Reference

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

java.lang.Object
  extended by com.genesyslab.platform.commons.GEnum
      extended by com.genesyslab.platform.reporting.protocol.statserver.NotificationMode

public class NotificationMode
extends GEnum

Specifies how often Stat Server will send updates on the requested statistical values.


Field Summary
static NotificationMode Immediate
          Stat Server reports statistics whenever a statistical value changes; for time-related statistics, Immediate means that Stat Server will report the current value whenever a statistical value changes, but it will also report that value periodically, using the specified notification frequency.
static NotificationMode NoNotification
          Allows you to retrieve statistics when you want them.
static NotificationMode Periodical
          Stat Server reports statistics based on the time period you request.
static NotificationMode Reset
          Stat Server reports the current value right before setting the statistical value to zero (0).
 
Fields inherited from class com.genesyslab.platform.commons.GEnum
LOCALE_ENGLISH
 
Method Summary
static NotificationMode valueOf(int ordinal)
          Returns enumeration value by given ordinal number.
static NotificationMode valueOf(java.lang.String name)
          Returns enumeration value with specified name or null if no such value exists.
static java.util.Collection<NotificationMode> values()
          Returns all values of the enumeration.
 
Methods inherited from class com.genesyslab.platform.commons.GEnum
asInteger, enumSize, equals, equals, getEnumMap, getEnumValues, getValue, getValue, getValue, hashCode, name, ordinal, toString, valueOf, valueOf, values, valuesBy
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

Immediate

public static final NotificationMode Immediate
Stat Server reports statistics whenever a statistical value changes; for time-related statistics, Immediate means that Stat Server will report the current value whenever a statistical value changes, but it will also report that value periodically, using the specified notification frequency.


Periodical

public static final NotificationMode Periodical
Stat Server reports statistics based on the time period you request.


NoNotification

public static final NotificationMode NoNotification
Allows you to retrieve statistics when you want them.


Reset

public static final NotificationMode Reset
Stat Server reports the current value right before setting the statistical value to zero (0).

Method Detail

values

public static java.util.Collection<NotificationMode> values()
Returns all values of the enumeration.

Returns:
all enumeration values

valueOf

public static NotificationMode valueOf(int ordinal)
Returns enumeration value by given ordinal number.

Parameters:
ordinal - ordinal number of the enumeration value
Returns:
the enumeration value with given ordinal number or null

valueOf

public static NotificationMode valueOf(java.lang.String name)
Returns enumeration value with specified name or null if no such value exists.

Parameters:
name - name of value in the enumeration
Returns:
enumeration value with specified name or null

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.