Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaEnumeratorValue

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

public class CfgDeltaEnumeratorValue
extends CfgDelta

The changes to make to a CfgEnumeratorValue object.


Constructor Summary
CfgDeltaEnumeratorValue(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaEnumeratorValue(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaEnumeratorValue(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 CfgEnumeratorValue configuration object.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          A pointer to the description of the enumerator value.
 java.lang.String getDisplayName()
          A pointer to the display name of the enumerator to be shown on GUI and in reports.
 CfgEnumerator getEnumerator()
          A unique identifier of the CfgEnumerator to which this value is allocated.
 java.lang.Integer getEnumeratorDBID()
          Retrieves the dbid of the object that is being linked to by the Enumerator property.
 CfgFlag getIsDefault()
          An indicator whether the value is default.
 java.lang.String getName()
          A pointer to the system name of the enumerator to be used primarily by Genesys applications.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this enumerator value is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgEnumeratorValue retrieveCfgEnumeratorValue()
          Read base CfgEnumeratorValue 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

CfgDeltaEnumeratorValue

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

Parameters:
confService - configuration service instance

CfgDeltaEnumeratorValue

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

CfgDeltaEnumeratorValue

public CfgDeltaEnumeratorValue(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 CfgEnumeratorValue configuration object.

Returns:
target object DBID

retrieveCfgEnumeratorValue

public final CfgEnumeratorValue retrieveCfgEnumeratorValue()
                                                    throws ConfigException
Read base CfgEnumeratorValue configuration object caused this event.

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

getEnumerator

public final CfgEnumerator getEnumerator()
A unique identifier of the CfgEnumerator to which this value is allocated. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

getEnumeratorDBID

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

Returns:
DBID identifier of referred object or null

getTenant

public final CfgTenant getTenant()
A unique identifier of the CfgTenant to which this enumerator value 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 the system name of the enumerator to be used primarily by Genesys applications. Mandatory. Must be unique within the enumerator object. Once specified, can not be changed.

Returns:
property value or null

getDescription

public final java.lang.String getDescription()
A pointer to the description of the enumerator value.

Returns:
property value or null

getIsDefault

public final CfgFlag getIsDefault()
An indicator whether the value is default. See CfgFlag

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

getDisplayName

public final java.lang.String getDisplayName()
A pointer to the display name of the enumerator to be shown on GUI and in reports. Mandatory.

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.