Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaStatDay

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.CfgDeltaStatDay
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaStatDay
extends CfgDelta

The changes to make to a CfgStatDay object.


Constructor Summary
CfgDeltaStatDay(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaStatDay(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaStatDay(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<CfgStatInterval> getAddedStatIntervals()
          A pointer to the list of the structures of CfgStatInterval type that associate intervals with certain statistical values.
 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.util.Collection<CfgStatInterval> getChangedStatIntervals()
          A pointer to the list of structures of type CfgStatInterval that contain information about stat intervals whose values have been changed.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.util.Calendar getDate()
          Day of specific year calculated since 00:00:00 GMT Jan 1, 1970 measured in seconds.
 java.lang.Integer getDay()
          Day's number.
 java.lang.Integer getDBID()
          The DBID of the target CfgStatDay configuration object.
 java.util.Collection<CfgStatInterval> getDeletedStatIntervals()
          A pointer to the list of numbers of stat intervals that are no longer defined within this stat day (every item of this list has variable type int).
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.Integer getEndTime()
          End of business time of day measured in minutes from 00:00.
 java.lang.Integer getFlatRate()
          Amount to be charged for processing the forecast volume of interactions.
 java.lang.Integer getIntervalLength()
          Statistical interval in minutes.
 CfgFlag getIsDayOfWeek()
          Indicator of whether this day is identified as a day of week ( CFGTrue) or a day of year (CFGFalse).
 java.lang.Integer getMaxValue()
          Maximum statistical value for the day.
 java.lang.Integer getMinValue()
          Minimum statistical value for the day.
 java.lang.String getName()
          A pointer to the name of the day.
 java.lang.Integer getStartTime()
          Start of business time of day measured in minutes from 00:00.
 CfgObjectState getState()
          Current object state.
 java.lang.Integer getTargetValue()
          Target statistical value for the day.
 CfgTenant getTenant()
          A unique identifier of the Tenant that this day is defined for.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgStatDayType getType()
          Statistical Day type.
 CfgFlag getUseFlatRate()
          Flag determining whether flatRate (CFGTrue) should be selected.
 CfgStatDay retrieveCfgStatDay()
          Read base CfgStatDay 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

CfgDeltaStatDay

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

Parameters:
confService - configuration service instance

CfgDeltaStatDay

public CfgDeltaStatDay(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

CfgDeltaStatDay

public CfgDeltaStatDay(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 CfgStatDay configuration object.

Returns:
target object DBID

retrieveCfgStatDay

public final CfgStatDay retrieveCfgStatDay()
                                    throws ConfigException
Read base CfgStatDay 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 day 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 day. Mandatory. Must be unique within the tenant.

Returns:
property value or null

getIsDayOfWeek

public final CfgFlag getIsDayOfWeek()
Indicator of whether this day is identified as a day of week ( CFGTrue) or a day of year (CFGFalse). Mandatory. Once specified, cannot be changed. The parameter is ignored if value of parameter date is specified. Refer to CfgFlag

Returns:
property value or null

getDay

public final java.lang.Integer getDay()
Day's number. If isDayOfWeek is set to CFGTrue, the allowable range is from 1 to 7 (where 1 stands for Sunday). If isDayOfWeek is set to CFGFalse, the allowable range is from 1 to 366 and 1 (where 1 stands for January 1 and -1 stands for any day). Mandatory. Once specified, cannot be changed. The parameter is ignored if value of parameter date is specified.

Returns:
property value or null

getStartTime

public final java.lang.Integer getStartTime()
Start of business time of day measured in minutes from 00:00. Cannot be negative and can not be greater than 1440.

Returns:
property value or null

getEndTime

public final java.lang.Integer getEndTime()
End of business time of day measured in minutes from 00:00. Cannot be negative and can not be greater than 1440. If set to be less than the setting for startTime, implies the time of the next calendar day (night shift).

Returns:
property value or null

getMinValue

public final java.lang.Integer getMinValue()
Minimum statistical value for the day. Cannot be negative.

Returns:
property value or null

getMaxValue

public final java.lang.Integer getMaxValue()
Maximum statistical value for the day. Cannot be negative or less than the setting for minValue.

Returns:
property value or null

getTargetValue

public final java.lang.Integer getTargetValue()
Target statistical value for the day. Cannot be less than the setting for minVlaue or greater than the setting for maxValue.

Returns:
property value or null

getIntervalLength

public final java.lang.Integer getIntervalLength()
Statistical interval in minutes. Must be a multiple of five. Once specified, cannot be changed. Recommended to be set to 15 by default.

Returns:
property value or null

getAddedStatIntervals

public final java.util.Collection<CfgStatInterval> getAddedStatIntervals()
A pointer to the list of the structures of CfgStatInterval type that associate intervals with certain statistical values. When used as an entry in CfgDeltaStatDay (see below), it is a pointer to a list of structures of type CfgStatInterval added to the existing list.

Returns:
list of structures or null

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

getDate

public final java.util.Calendar getDate()
Day of specific year calculated since 00:00:00 GMT Jan 1, 1970 measured in seconds. Once specified, cannot be changed. If value is specified the values of parameters isDayOfWeek and day must be ignored.

Returns:
property value or null

getType

public final CfgStatDayType getType()
Statistical Day type. Refer to CfgStatDayType

Returns:
property value or null

getUseFlatRate

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

Returns:
property value or null

getFlatRate

public final java.lang.Integer getFlatRate()
Amount to be charged for processing the forecast volume of interactions.

Returns:
property value or null

getDeletedStatIntervals

public final java.util.Collection<CfgStatInterval> getDeletedStatIntervals()
A pointer to the list of numbers of stat intervals that are no longer defined within this stat day (every item of this list has variable type int).

Returns:
list of numeric values or null

getChangedStatIntervals

public final java.util.Collection<CfgStatInterval> getChangedStatIntervals()
A pointer to the list of structures of type CfgStatInterval that contain information about stat intervals whose values have been changed.

Returns:
list of structures 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.