Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgStatTable

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgObject
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgStatTable
All Implemented Interfaces:
ICfgBase, ICfgObject, java.lang.Cloneable

public class CfgStatTable
extends CfgObject

Statistical Tables are groups of Statistical Days that represent statistically-modeled performances of Agent Groups over a calendar period of up to one year.

Call-processing applications can use Statistical Tables to provide load balancing between Agent Groups when the real-time statistics for those groups are unavailable.

Deletion of Stat Table X will cause the following events set out in the order of arrival:



See also:

CfgDeltaStatTable

CfgStatDay


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgStatTable(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgStatTable(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgStatTable(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
 
Method Summary
 java.lang.Integer getAgentHourlyRate()
          The hourly rate for an agent.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.lang.Integer getFlatRate()
          A flat rate measured in cost units.
 java.lang.String getName()
          A pointer to the name of the table.
 java.util.Collection<java.lang.Integer> getStatDayDBIDs()
          Retrieves dbids of objects that are being linked to by the StatDays property.
 java.util.Collection<CfgStatDay> getStatDays()
          A pointer to the list of identifiers of the Statistical Days that constitute the table.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the Tenant that this table is defined for.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgStatTableType getType()
          Type of stat table.
 CfgFlag getUseFlatRate()
          Flag determining whether flatRate (CFGTrue) or agentHourlyRate (CFGFalse) should be selected.
 KeyValueCollection getUserProperties()
          A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
 java.lang.Integer getWaitThreshold()
          The time the Universal Routing Server can wait until the corresponding resources become available.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setAgentHourlyRate(java.lang.Integer value)
          The hourly rate for an agent.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setFlatRate(java.lang.Integer value)
          A flat rate measured in cost units.
 void setName(java.lang.String value)
          A pointer to the name of the table.
 void setStatDayDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the StatDays property.
 void setStatDays(java.util.Collection<CfgStatDay> value)
          A pointer to the list of identifiers of the Statistical Days that constitute the table.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the Tenant that this table is defined for.
 void setTenantDBID(int dbid)
          A unique identifier of the Tenant that this table is defined for.
 void setType(CfgStatTableType value)
          Type of stat table.
 void setUseFlatRate(CfgFlag value)
          Flag determining whether flatRate (CFGTrue) or agentHourlyRate (CFGFalse) should be selected.
 void setUserProperties(KeyValueCollection value)
          A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
 void setWaitThreshold(java.lang.Integer value)
          The time the Universal Routing Server can wait until the corresponding resources become available.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, ensureDataBackup, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, update, updateACL
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase
equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getParent, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, resolveLink, setProperty, toString, toStringProperties, toXml, updateChildrenSavedState
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgBase
getEndpoint, getProperty, getRawObjectData, setProperty, toXml
 

Field Detail

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgStatTable

public CfgStatTable(IConfService confService,
                    ConfObject objData,
                    boolean isSaved,
                    java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object data structure
isSaved - indicator of the object saved state
additionalParameters - additional parameters from configuration protocol message

CfgStatTable

public CfgStatTable(IConfService confService,
                    org.w3c.dom.Node xmlData,
                    java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object data
additionalParameters - additional parameters from configuration protocol message

CfgStatTable

public CfgStatTable(IConfService confService)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
Method Detail

save

public void save()
          throws ConfigException
Synchronizes changes in the class with Configuration Server.

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

getDBID

public final java.lang.Integer getDBID()
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Returns:
property value or null

setDBID

public final void setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Parameters:
value - new property value
See Also:
getDBID()

getTenant

public final CfgTenant getTenant()
A unique identifier of the Tenant that this table is defined for. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the Tenant that this table is defined for. Mandatory. Once specified, cannot be changed.

Parameters:
value - new property value
See Also:
getTenant()

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the Tenant that this table is defined for. Mandatory. Once specified, cannot be changed.

Parameters:
dbid - DBID identifier of referred object
See Also:
getTenant()

getTenantDBID

public final java.lang.Integer getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property.

Returns:
DBID identifier of referred object or null

getName

public final java.lang.String getName()
A pointer to the name of the table. Mandatory. Must be unique within the tenant.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the name of the table. Mandatory. Must be unique within the tenant.

Parameters:
value - new property value
See Also:
getName()

getType

public final CfgStatTableType getType()
Type of stat table. Once specified, cannot be changed. Refer to CfgStatTableType .

Returns:
property value or null

setType

public final void setType(CfgStatTableType value)
Type of stat table. Once specified, cannot be changed. Refer to CfgStatTableType .

Parameters:
value - new property value
See Also:
getType()

getStatDays

public final java.util.Collection<CfgStatDay> getStatDays()
A pointer to the list of identifiers of the Statistical Days that constitute the table. When used as an entry in CfgDeltaStatTable (see below), it is a pointer to a list of days added to the existing list.

Returns:
list of configuration objects or null

setStatDays

public final void setStatDays(java.util.Collection<CfgStatDay> value)
A pointer to the list of identifiers of the Statistical Days that constitute the table. When used as an entry in CfgDeltaStatTable (see below), it is a pointer to a list of days added to the existing list.

Parameters:
value - new property value
See Also:
getStatDays()

getStatDayDBIDs

public final java.util.Collection<java.lang.Integer> getStatDayDBIDs()
Retrieves dbids of objects that are being linked to by the StatDays property. It's a snapshot collection containing original values. Modification of this collection instance will not affect actual value of the objects' property.

Returns:
collection of DBID identifiers of referred objects or null

setStatDayDBIDs

public final void setStatDayDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the StatDays property.

Parameters:
value - collection of DBID identifiers of referred objects

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

setState

public final void setState(CfgObjectState value)
Current object state. Mandatory. Refer to CfgObjectState

Parameters:
value - new property value
See Also:
getState()

getUserProperties

public final KeyValueCollection getUserProperties()
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.

Returns:
property value or null

setUserProperties

public final void setUserProperties(KeyValueCollection value)
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.

Parameters:
value - new property value
See Also:
getUserProperties()

getWaitThreshold

public final java.lang.Integer getWaitThreshold()
The time the Universal Routing Server can wait until the corresponding resources become available.

Returns:
property value or null

setWaitThreshold

public final void setWaitThreshold(java.lang.Integer value)
The time the Universal Routing Server can wait until the corresponding resources become available.

Parameters:
value - new property value
See Also:
getWaitThreshold()

getFlatRate

public final java.lang.Integer getFlatRate()
A flat rate measured in cost units.

Returns:
property value or null

setFlatRate

public final void setFlatRate(java.lang.Integer value)
A flat rate measured in cost units.

Parameters:
value - new property value
See Also:
getFlatRate()

getAgentHourlyRate

public final java.lang.Integer getAgentHourlyRate()
The hourly rate for an agent. This value is used only for Variable Rate Contracts.

Returns:
property value or null

setAgentHourlyRate

public final void setAgentHourlyRate(java.lang.Integer value)
The hourly rate for an agent. This value is used only for Variable Rate Contracts.

Parameters:
value - new property value
See Also:
getAgentHourlyRate()

getUseFlatRate

public final CfgFlag getUseFlatRate()
Flag determining whether flatRate (CFGTrue) or agentHourlyRate (CFGFalse) should be selected. Refer to CfgFlag

Returns:
property value or null

setUseFlatRate

public final void setUseFlatRate(CfgFlag value)
Flag determining whether flatRate (CFGTrue) or agentHourlyRate (CFGFalse) should be selected. Refer to CfgFlag

Parameters:
value - new property value
See Also:
getUseFlatRate()

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.