Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgStatDay

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

public class CfgStatDay
extends CfgObject

A Statistical Day is a numerically-expressed workload that a particular Agent Group is expected to handle during a particular business day.

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



See also:

CfgDeltaStatDay

CfgStatTable


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgStatDay(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgStatDay(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgStatDay(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.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()
          An identifier of this object in the Configuration Database.
 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.util.Collection<CfgStatInterval> getStatIntervals()
          A pointer to the list of the structures of CfgStatInterval type that associate intervals with certain statistical values.
 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.
 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.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setDate(java.util.Calendar value)
          Day of specific year calculated since 00:00:00 GMT Jan 1, 1970 measured in seconds.
 void setDay(java.lang.Integer value)
          Day's number.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setEndTime(java.lang.Integer value)
          End of business time of day measured in minutes from 00:00.
 void setFlatRate(java.lang.Integer value)
          Amount to be charged for processing the forecast volume of interactions.
 void setIntervalLength(java.lang.Integer value)
          Statistical interval in minutes.
 void setIsDayOfWeek(CfgFlag value)
          Indicator of whether this day is identified as a day of week ( CFGTrue) or a day of year (CFGFalse).
 void setMaxValue(java.lang.Integer value)
          Maximum statistical value for the day.
 void setMinValue(java.lang.Integer value)
          Minimum statistical value for the day.
 void setName(java.lang.String value)
          A pointer to the name of the day.
 void setStartTime(java.lang.Integer value)
          Start of business time of day measured in minutes from 00:00.
 void setState(CfgObjectState value)
          Current object state.
 void setStatIntervals(java.util.Collection<CfgStatInterval> value)
          A pointer to the list of the structures of CfgStatInterval type that associate intervals with certain statistical values.
 void setTargetValue(java.lang.Integer value)
          Target statistical value for the day.
 void setTenant(CfgTenant value)
          A unique identifier of the Tenant that this day is defined for.
 void setTenantDBID(int dbid)
          A unique identifier of the Tenant that this day is defined for.
 void setType(CfgStatDayType value)
          Statistical Day type.
 void setUseFlatRate(CfgFlag value)
          Flag determining whether flatRate (CFGTrue) 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.
 
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

CfgStatDay

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

CfgStatDay

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

CfgStatDay

public CfgStatDay(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 day 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 day 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 day 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 day. 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 day. Mandatory. Must be unique within the tenant.

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

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

setIsDayOfWeek

public final void setIsDayOfWeek(CfgFlag value)
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

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

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

setDay

public final void setDay(java.lang.Integer value)
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.

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

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

setStartTime

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

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

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

setEndTime

public final void setEndTime(java.lang.Integer value)
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).

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

getMinValue

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

Returns:
property value or null

setMinValue

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

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

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

setMaxValue

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

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

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

setTargetValue

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

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

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

setIntervalLength

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

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

getStatIntervals

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

setStatIntervals

public final void setStatIntervals(java.util.Collection<CfgStatInterval> value)
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.

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

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()

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

setDate

public final void setDate(java.util.Calendar value)
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.

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

getType

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

Returns:
property value or null

setType

public final void setType(CfgStatDayType value)
Statistical Day type. Refer to CfgStatDayType

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

getUseFlatRate

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

Returns:
property value or null

setUseFlatRate

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

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

getFlatRate

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

Returns:
property value or null

setFlatRate

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

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

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.