Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaVoicePrompt

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

public class CfgDeltaVoicePrompt
extends CfgDelta

The changes to make to a CfgVoicePrompt object.


Constructor Summary
CfgDeltaVoicePrompt(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaVoicePrompt(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaVoicePrompt(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 CfgVoicePrompt configuration object.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          A pointer to the voice prompt description.
 java.lang.String getName()
          A pointer to the voice prompt name that identifies the voice prompt.
 CfgScript getScript()
          A unique identifier of the CfgScript for this voice prompt.
 java.lang.Integer getScriptDBID()
          Retrieves the dbid of the object that is being linked to by the Script property.
 CfgObjectState getState()
          Current object state.
 CfgSwitch getSwitch()
          A unique identifier of the CfgSwitch to which this voice prompt belongs.
 java.lang.Integer getSwitchDBID()
          Retrieves the dbid of the object that is being linked to by the Switch property.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this voice prompt is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgVoicePrompt retrieveCfgVoicePrompt()
          Read base CfgVoicePrompt 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

CfgDeltaVoicePrompt

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

Parameters:
confService - configuration service instance

CfgDeltaVoicePrompt

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

CfgDeltaVoicePrompt

public CfgDeltaVoicePrompt(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 CfgVoicePrompt configuration object.

Returns:
target object DBID

retrieveCfgVoicePrompt

public final CfgVoicePrompt retrieveCfgVoicePrompt()
                                            throws ConfigException
Read base CfgVoicePrompt configuration object caused this event.

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

getSwitch

public final CfgSwitch getSwitch()
A unique identifier of the CfgSwitch to which this voice prompt belongs. Optional.

Returns:
instance of referred object or null

getSwitchDBID

public final java.lang.Integer getSwitchDBID()
Retrieves the dbid of the object that is being linked to by the Switch 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 voice prompt is allocated. Read only.

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 voice prompt name that identifies the voice prompt. Should be equal to the voice prompt identifier provided by switch if used for parked call treating. Mandatory. Once specified cannot be changed. Must be unique within tenant it belongs to.

Returns:
property value or null

getDescription

public final java.lang.String getDescription()
A pointer to the voice prompt description. Can be used by parking platform or switch for generating voice prompt (Text-to-Speech).

Returns:
property value or null

getScript

public final CfgScript getScript()
A unique identifier of the CfgScript for this voice prompt.

Returns:
instance of referred object or null

getScriptDBID

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

Returns:
DBID identifier of referred object 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

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.