Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaStatTable

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.CfgDelta
              extended by com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaStatTable
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaStatTable
extends CfgDelta

The changes to make to a CfgStatTable object.


Constructor Summary
CfgDeltaStatTable(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaStatTable(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaStatTable(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 java.util.Collection<java.lang.Integer> getAddedStatDayDBIDs()
          A pointer to the list of identifiers of the Statistical Days that constitute the table.
 java.util.Collection<CfgStatDay> getAddedStatDays()
          A pointer to the list of identifiers of the Statistical Days that constitute the table.
 KeyValueCollection getAddedUserProperties()
          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 getAgentHourlyRate()
          The hourly rate for an agent.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.lang.Integer getDBID()
          The DBID of the target CfgStatTable configuration object.
 java.util.Collection<java.lang.Integer> getDeletedStatDayDBIDs()
          A pointer to the list of identifiers of stat days that are no longer defined within this table.
 java.util.Collection<CfgStatDay> getDeletedStatDays()
          A pointer to the list of identifiers of stat days that are no longer defined within this table.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 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()
          Deprecated.  
 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.
 java.lang.Integer getWaitThreshold()
          The time the Universal Routing Server can wait until the corresponding resources become available.
 CfgStatTable retrieveCfgStatTable()
          Read base CfgStatTable configuration object caused this event.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgDelta
ensureDataBackup, retrieveObject, save, toStringProperties, update
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, 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, 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
 

Constructor Detail

CfgDeltaStatTable

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

Parameters:
confService - configuration service instance

CfgDeltaStatTable

public CfgDeltaStatTable(IConfService confService,
                         ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object delta data

CfgDeltaStatTable

public CfgDeltaStatTable(IConfService confService,
                         org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object delta data
Method Detail

getDBID

public final java.lang.Integer getDBID()
The DBID of the target CfgStatTable configuration object.

Returns:
target object DBID

retrieveCfgStatTable

public final CfgStatTable retrieveCfgStatTable()
                                        throws ConfigException
Read base CfgStatTable configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

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

getTenantDBID

public final java.lang.Integer getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. Configuration server provides it only if the property value has been changed.

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

getType

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

Returns:
property value or null

getAddedStatDays

public final java.util.Collection<CfgStatDay> getAddedStatDays()
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

getAddedStatDayDBIDs

public final java.util.Collection<java.lang.Integer> getAddedStatDayDBIDs()
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:
collection of DBID identifiers of referred objects or null

getStatDayDBIDs

@Deprecated
public final java.util.Collection<java.lang.Integer> getStatDayDBIDs()
Deprecated. 

See Also:
getAddedStatDayDBIDs()

getState

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

Returns:
property value or null

getAddedUserProperties

public final KeyValueCollection getAddedUserProperties()
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

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

getFlatRate

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

Returns:
property value or null

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

getUseFlatRate

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

Returns:
property value or null

getDeletedStatDays

public final java.util.Collection<CfgStatDay> getDeletedStatDays()
A pointer to the list of identifiers of stat days that are no longer defined within this table.

Returns:
list of configuration objects or null

getDeletedStatDayDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedStatDayDBIDs()
A pointer to the list of identifiers of stat days that are no longer defined within this table.

Returns:
collection of DBID identifiers of referred objects or null

getDeletedUserProperties

public final KeyValueCollection getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. Has the same structure as parameter userProperties.

Returns:
property value or null

getChangedUserProperties

public final KeyValueCollection getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. Has the same structure as parameter userProperties

Returns:
property value 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.