Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaIVRPort

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

public class CfgDeltaIVRPort
extends CfgDelta

The changes to make to a CfgIVRPort object.


Constructor Summary
CfgDeltaIVRPort(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaIVRPort(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaIVRPort(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 CfgIVRPort configuration object.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          A pointer to the string describing IVR port.
 CfgDN getDN()
          A unique identifier of CfgDN associated with this IVR port.
 java.lang.Integer getDNDBID()
          Retrieves the dbid of the object that is being linked to by the DN property.
 CfgIVR getIVR()
          A unique identifier of CfgIVR this IVR port belongs to.
 java.lang.Integer getIVRDBID()
          Retrieves the dbid of the object that is being linked to by the IVR property.
 java.lang.String getPortNumber()
          A pointer to the string, representing number associated with channel on IVR.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this IVR port belongs.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgIVRPort retrieveCfgIVRPort()
          Read base CfgIVRPort 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

CfgDeltaIVRPort

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

Parameters:
confService - configuration service instance

CfgDeltaIVRPort

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

CfgDeltaIVRPort

public CfgDeltaIVRPort(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 CfgIVRPort configuration object.

Returns:
target object DBID

retrieveCfgIVRPort

public final CfgIVRPort retrieveCfgIVRPort()
                                    throws ConfigException
Read base CfgIVRPort 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 IVR port belongs. Read-only (set automatically according to the current value of tenantDBID of the IVR specified in IVRDBID). See type CfgIVR .

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

getPortNumber

public final java.lang.String getPortNumber()
A pointer to the string, representing number associated with channel on IVR. Mandatory. Must be unique within one IVR. Once specified cannot be changed.

Returns:
property value or null

getDescription

public final java.lang.String getDescription()
A pointer to the string describing IVR port.

Returns:
property value or null

getIVR

public final CfgIVR getIVR()
A unique identifier of CfgIVR this IVR port belongs to. Mandatory. Once specified, can not be changed

Returns:
instance of referred object or null

getIVRDBID

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

Returns:
DBID identifier of referred object or null

getDN

public final CfgDN getDN()
A unique identifier of CfgDN associated with this IVR port.

Returns:
instance of referred object or null

getDNDBID

public final java.lang.Integer getDNDBID()
Retrieves the dbid of the object that is being linked to by the DN 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.