Platform SDK Java 8.5 API Reference

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

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.StatisticMetricEx
All Implemented Interfaces:
ProtocolDescriptionSupport

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


Constructor Summary
StatisticMetricEx()
           
 
Method Summary
static StatisticMetricEx create()
          Creates instance of StatisticMetricEx with no parameters set.
static StatisticMetricEx create(StatisticCategory category, ActionsMask mainMask, ActionsMask relativeMask, StatisticSubject subject)
          Creates instance of StatisticMetricEx.
static StatisticMetricEx create(StatisticCategory category, ActionsMask mainMask, ActionsMask relativeMask, StatisticSubject subject, StatisticInterval intervalType, java.lang.Integer intervalLength, java.lang.String dynamicTimeProfile, java.lang.String dynamicFilter, java.lang.Integer timeRangeLeft, java.lang.Integer timeRangeRight, java.lang.Integer timeRangeLeft2, java.lang.Integer timeRangeRight2, java.lang.String dynamicUserDataFormula, java.lang.Boolean distinguishByConnId)
          Creates instance of StatisticMetricEx.
static StatisticMetricEx create(StatisticCategory category, ActionsMask mainMask, ActionsMask relativeMask, StatisticSubject subject, java.lang.String timeProfile, java.lang.String filter)
          Creates instance of StatisticMetricEx.
static StatisticMetricEx create(StatisticCategory category, ActionsMask mainMask, ActionsMask relativeMask, StatisticSubject subject, java.lang.String timeProfile, java.lang.String filter, java.lang.Integer timeRangeLeft, java.lang.Integer timeRangeRight, java.lang.Integer timeRangeLeft2, java.lang.Integer timeRangeRight2, java.lang.String dynamicUserDataFormula, java.lang.Boolean distinguishByConnId)
          Creates instance of StatisticMetricEx.
abstract  StatisticCategory getCategory()
          Specifies the algorithm used to calculate a particular statistic.
abstract  java.lang.Boolean getDistinguishByConnId()
          Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.
abstract  java.lang.String getDynamicFilter()
           
abstract  java.lang.String getDynamicTimeProfile()
           
abstract  java.lang.String getDynamicUserDataFormula()
           
abstract  java.lang.String getFilter()
          The filter to be used for a statistic metric (See Reporting Technical Reference Guide for more information).
abstract  java.lang.Integer getIntervalLength()
          Interval length for historical statistics.
abstract  StatisticInterval getIntervalType()
          Type of interval being used to capture historical statistics.
abstract  ActionsMask getMainMask()
          Specifies the set of actions or statuses Stat Server considers when calculating a statistic.
abstract  ActionsMask getRelativeMask()
          A mask used for calculating statistics reflecting relative values, such as percentages and averages.
abstract  StatisticSubject getSubject()
          Specifies the object type that will be considered as a source of statistical data.
abstract  java.lang.String getTimeProfile()
          The time profile to be used for a statistic metric (See Reporting Technical Reference Guide for more information).
abstract  java.lang.Integer getTimeRangeLeft()
           
abstract  java.lang.Integer getTimeRangeLeft2()
           
abstract  java.lang.Integer getTimeRangeRight()
           
abstract  java.lang.Integer getTimeRangeRight2()
           
abstract  void setCategory(StatisticCategory category)
          Specifies the algorithm used to calculate a particular statistic.
abstract  void setDistinguishByConnId(java.lang.Boolean distinguishByConnId)
          Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.
abstract  void setDynamicFilter(java.lang.String dynamicFilter)
           
abstract  void setDynamicTimeProfile(java.lang.String dynamicTimeProfile)
           
abstract  void setDynamicUserDataFormula(java.lang.String dynamicUserDataFormula)
           
abstract  void setFilter(java.lang.String filter)
          The filter to be used for a statistic metric (See Reporting Technical Reference Guide for more information).
abstract  void setIntervalLength(int intervalLength)
          Interval length for historical statistics.
abstract  void setIntervalLength(java.lang.Integer intervalLength)
          Interval length for historical statistics.
abstract  void setIntervalType(StatisticInterval intervalType)
          Type of interval being used to capture historical statistics.
abstract  void setMainMask(ActionsMask mainMask)
          Specifies the set of actions or statuses Stat Server considers when calculating a statistic.
abstract  void setRelativeMask(ActionsMask relativeMask)
          A mask used for calculating statistics reflecting relative values, such as percentages and averages.
abstract  void setSubject(StatisticSubject subject)
          Specifies the object type that will be considered as a source of statistical data.
abstract  void setTimeProfile(java.lang.String timeProfile)
          The time profile to be used for a statistic metric (See Reporting Technical Reference Guide for more information).
abstract  void setTimeRangeLeft(int timeRangeLeft)
           
abstract  void setTimeRangeLeft(java.lang.Integer timeRangeLeft)
           
abstract  void setTimeRangeLeft2(int timeRangeLeft2)
           
abstract  void setTimeRangeLeft2(java.lang.Integer timeRangeLeft2)
           
abstract  void setTimeRangeRight(int timeRangeRight)
           
abstract  void setTimeRangeRight(java.lang.Integer timeRangeRight)
           
abstract  void setTimeRangeRight2(int timeRangeRight2)
           
abstract  void setTimeRangeRight2(java.lang.Integer timeRangeRight2)
           
 
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

StatisticMetricEx

public StatisticMetricEx()
Method Detail

create

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

Returns:
instance of StatisticMetricEx

create

public static StatisticMetricEx create(StatisticCategory category,
                                       ActionsMask mainMask,
                                       ActionsMask relativeMask,
                                       StatisticSubject subject)
Creates instance of StatisticMetricEx.

Parameters:
category - Category
mainMask - MainMask
relativeMask - RelativeMask
subject - Subject
Returns:
instance of StatisticMetricEx

create

public static StatisticMetricEx create(StatisticCategory category,
                                       ActionsMask mainMask,
                                       ActionsMask relativeMask,
                                       StatisticSubject subject,
                                       java.lang.String timeProfile,
                                       java.lang.String filter)
Creates instance of StatisticMetricEx.

Parameters:
category - Category
mainMask - MainMask
relativeMask - RelativeMask
subject - Subject
timeProfile - TimeProfile
filter - Filter
Returns:
instance of StatisticMetricEx

create

public static StatisticMetricEx create(StatisticCategory category,
                                       ActionsMask mainMask,
                                       ActionsMask relativeMask,
                                       StatisticSubject subject,
                                       java.lang.String timeProfile,
                                       java.lang.String filter,
                                       java.lang.Integer timeRangeLeft,
                                       java.lang.Integer timeRangeRight,
                                       java.lang.Integer timeRangeLeft2,
                                       java.lang.Integer timeRangeRight2,
                                       java.lang.String dynamicUserDataFormula,
                                       java.lang.Boolean distinguishByConnId)
Creates instance of StatisticMetricEx.

Parameters:
category - Category
mainMask - MainMask
relativeMask - RelativeMask
subject - Subject
timeProfile - TimeProfile
filter - Filter
timeRangeLeft - TimeRangeLeft
timeRangeRight - TimeRangeRight
timeRangeLeft2 - TimeRangeLeft2
timeRangeRight2 - TimeRangeRight2
dynamicUserDataFormula - DynamicUserDataFormula
distinguishByConnId - DistinguishByConnId
Returns:
instance of StatisticMetricEx

create

public static StatisticMetricEx create(StatisticCategory category,
                                       ActionsMask mainMask,
                                       ActionsMask relativeMask,
                                       StatisticSubject subject,
                                       StatisticInterval intervalType,
                                       java.lang.Integer intervalLength,
                                       java.lang.String dynamicTimeProfile,
                                       java.lang.String dynamicFilter,
                                       java.lang.Integer timeRangeLeft,
                                       java.lang.Integer timeRangeRight,
                                       java.lang.Integer timeRangeLeft2,
                                       java.lang.Integer timeRangeRight2,
                                       java.lang.String dynamicUserDataFormula,
                                       java.lang.Boolean distinguishByConnId)
Creates instance of StatisticMetricEx.

Parameters:
category - Category
mainMask - MainMask
relativeMask - RelativeMask
subject - Subject
intervalType - IntervalType
intervalLength - IntervalLength
dynamicTimeProfile - DynamicTimeProfile
dynamicFilter - DynamicFilter
timeRangeLeft - TimeRangeLeft
timeRangeRight - TimeRangeRight
timeRangeLeft2 - TimeRangeLeft2
timeRangeRight2 - TimeRangeRight2
dynamicUserDataFormula - DynamicUserDataFormula
distinguishByConnId - DistinguishByConnId
Returns:
instance of StatisticMetricEx

getCategory

public abstract StatisticCategory getCategory()
Specifies the algorithm used to calculate a particular statistic.


setCategory

public abstract void setCategory(StatisticCategory category)
Specifies the algorithm used to calculate a particular statistic.


getMainMask

public abstract ActionsMask getMainMask()
Specifies the set of actions or statuses Stat Server considers when calculating a statistic.


setMainMask

public abstract void setMainMask(ActionsMask mainMask)
Specifies the set of actions or statuses Stat Server considers when calculating a statistic.


getRelativeMask

public abstract ActionsMask getRelativeMask()
A mask used for calculating statistics reflecting relative values, such as percentages and averages.


setRelativeMask

public abstract void setRelativeMask(ActionsMask relativeMask)
A mask used for calculating statistics reflecting relative values, such as percentages and averages.


getSubject

public abstract StatisticSubject getSubject()
Specifies the object type that will be considered as a source of statistical data.


setSubject

public abstract void setSubject(StatisticSubject subject)
Specifies the object type that will be considered as a source of statistical data.


getTimeProfile

public abstract java.lang.String getTimeProfile()
The time profile to be used for a statistic metric (See Reporting Technical Reference Guide for more information).


setTimeProfile

public abstract void setTimeProfile(java.lang.String timeProfile)
The time profile to be used for a statistic metric (See Reporting Technical Reference Guide for more information).


getFilter

public abstract java.lang.String getFilter()
The filter to be used for a statistic metric (See Reporting Technical Reference Guide for more information).


setFilter

public abstract void setFilter(java.lang.String filter)
The filter to be used for a statistic metric (See Reporting Technical Reference Guide for more information).


getTimeRangeLeft

public abstract java.lang.Integer getTimeRangeLeft()

setTimeRangeLeft

public abstract void setTimeRangeLeft(java.lang.Integer timeRangeLeft)

setTimeRangeLeft

public abstract void setTimeRangeLeft(int timeRangeLeft)

getTimeRangeRight

public abstract java.lang.Integer getTimeRangeRight()

setTimeRangeRight

public abstract void setTimeRangeRight(java.lang.Integer timeRangeRight)

setTimeRangeRight

public abstract void setTimeRangeRight(int timeRangeRight)

getTimeRangeLeft2

public abstract java.lang.Integer getTimeRangeLeft2()

setTimeRangeLeft2

public abstract void setTimeRangeLeft2(java.lang.Integer timeRangeLeft2)

setTimeRangeLeft2

public abstract void setTimeRangeLeft2(int timeRangeLeft2)

getTimeRangeRight2

public abstract java.lang.Integer getTimeRangeRight2()

setTimeRangeRight2

public abstract void setTimeRangeRight2(java.lang.Integer timeRangeRight2)

setTimeRangeRight2

public abstract void setTimeRangeRight2(int timeRangeRight2)

getDynamicUserDataFormula

public abstract java.lang.String getDynamicUserDataFormula()

setDynamicUserDataFormula

public abstract void setDynamicUserDataFormula(java.lang.String dynamicUserDataFormula)

getDistinguishByConnId

public abstract java.lang.Boolean getDistinguishByConnId()
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.


setDistinguishByConnId

public abstract void setDistinguishByConnId(java.lang.Boolean distinguishByConnId)
Specifies which type of profile information (statistical types, time profiles, time ranges, or filters) will be returned from a RequestGetStatisticProfile.


getIntervalType

public abstract StatisticInterval getIntervalType()
Type of interval being used to capture historical statistics.


setIntervalType

public abstract void setIntervalType(StatisticInterval intervalType)
Type of interval being used to capture historical statistics.


getDynamicTimeProfile

public abstract java.lang.String getDynamicTimeProfile()

setDynamicTimeProfile

public abstract void setDynamicTimeProfile(java.lang.String dynamicTimeProfile)

getDynamicFilter

public abstract java.lang.String getDynamicFilter()

setDynamicFilter

public abstract void setDynamicFilter(java.lang.String dynamicFilter)

getIntervalLength

public abstract java.lang.Integer getIntervalLength()
Interval length for historical statistics.


setIntervalLength

public abstract void setIntervalLength(java.lang.Integer intervalLength)
Interval length for historical statistics.


setIntervalLength

public abstract void setIntervalLength(int intervalLength)
Interval length for historical statistics.


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.