Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaTimeZone

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

public class CfgDeltaTimeZone
extends CfgDelta

CfgDeltaTimeZone is applicable for Configuration Library/Server release 5.1.5xx and later.


Constructor Summary
CfgDeltaTimeZone(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaTimeZone(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaTimeZone(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 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.
 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 CfgTimeZone configuration object.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          A pointer to time zone description.
 java.lang.Integer getDSTOffset()
          The value of DST offset.
 java.util.Calendar getDSTStartDate()
          DST start date.
 java.util.Calendar getDSTStopDate()
          DST stop date.
 CfgFlag getIsDSTObserved()
           
 java.lang.String getName()
          A pointer to time zone name.
 java.lang.String getNameMSExplorer()
          A pointer to the time zone name used by Microsoft browser.
 java.lang.String getNameNetscape()
          A pointer to the time zone name used by Netscape Navigator browser.
 java.lang.Integer getOffset()
          A time zone offset.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this time zone is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgTimeZone retrieveCfgTimeZone()
          Read base CfgTimeZone 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

CfgDeltaTimeZone

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

Parameters:
confService - configuration service instance

CfgDeltaTimeZone

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

CfgDeltaTimeZone

public CfgDeltaTimeZone(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 CfgTimeZone configuration object.

Returns:
target object DBID

retrieveCfgTimeZone

public final CfgTimeZone retrieveCfgTimeZone()
                                      throws ConfigException
Read base CfgTimeZone 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 CfgTenant to which this time zone is allocated. 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 time zone name. Mandatory. Must be unique within tenant environment.

Returns:
property value or null

getDescription

public final java.lang.String getDescription()
A pointer to time zone description.

Returns:
property value or null

getOffset

public final java.lang.Integer getOffset()
A time zone offset. Any integer value from -24 to 24. Must be considered as value -12 to 12 with 0.5 hour step.

Returns:
property value or null

getIsDSTObserved

public final CfgFlag getIsDSTObserved()

getDSTStartDate

public final java.util.Calendar getDSTStartDate()
DST start date. The value is: measured in seconds if 6.0 definition schema is uses. Refer to time_t from time.h of ANSI C library. Year value range 0-2038; performed based on calculation schema. (See comments.)

Returns:
property value or null

getDSTStopDate

public final java.util.Calendar getDSTStopDate()
DST stop date. The value is: measured in seconds if 6.0 definition schema is uses. Refer to time_t from time.h of ANSI C library. Year value range 0-2038; performed based on calculation schema. (See comments.)

Returns:
property value or null

getNameNetscape

public final java.lang.String getNameNetscape()
A pointer to the time zone name used by Netscape Navigator browser. Mandatory.

Returns:
property value or null

getNameMSExplorer

public final java.lang.String getNameMSExplorer()
A pointer to the time zone name used by Microsoft browser. Mandatory

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

getDSTOffset

public final java.lang.Integer getDSTOffset()
The value of DST offset. Default is 60 (minutes).

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