Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgIVR

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

public class CfgIVR
extends CfgObject

An IVR (Interactive Voice Response) is a telephony object that contains IVR Ports; it is controlled through IVR interface drivers.

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



See also:

CfgDeltaIVR

CfgIVRPort


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgIVR(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgIVR(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgIVR(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.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.lang.String getDescription()
          A pointer to the description of the IVR.
 CfgApplication getIVRServer()
          A unique identifier of the CfgApplication of CfgIVRInterfaceServer type permanently associated to serve this IVR.
 java.lang.Integer getIVRServerDBID()
          Retrieves the dbid of the object that is being linked to by the IVRServer property.
 java.lang.String getName()
          A pointer to the name of the IVR.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this IVR belongs.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgIVRType getType()
          Type of this IVR.
 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.
 java.lang.String getVersion()
          A pointer to the version of the IVR.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDescription(java.lang.String value)
          A pointer to the description of the IVR.
 void setIVRServer(CfgApplication value)
          A unique identifier of the CfgApplication of CfgIVRInterfaceServer type permanently associated to serve this IVR.
 void setIVRServerDBID(int dbid)
          A unique identifier of the CfgApplication of CfgIVRInterfaceServer type permanently associated to serve this IVR.
 void setName(java.lang.String value)
          A pointer to the name of the IVR.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the CfgTenant to which this IVR belongs.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant to which this IVR belongs.
 void setType(CfgIVRType value)
          Type of this IVR.
 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.
 void setVersion(java.lang.String value)
          A pointer to the version of the IVR.
 
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

CfgIVR

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

CfgIVR

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

CfgIVR

public CfgIVR(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 CfgTenant to which this IVR belongs. Once specified cannot be changed.

Returns:
instance of referred object or null

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the CfgTenant to which this IVR belongs. 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 CfgTenant to which this IVR belongs. 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 IVR. Mandatory. Must be unique within configuration database.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the name of the IVR. Mandatory. Must be unique within configuration database.

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

getDescription

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

Returns:
property value or null

setDescription

public final void setDescription(java.lang.String value)
A pointer to the description of the IVR.

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

getType

public final CfgIVRType getType()
Type of this IVR. See type CfgIVRType . Mandatory. Once specified cannot be changed.

Returns:
property value or null

setType

public final void setType(CfgIVRType value)
Type of this IVR. See type CfgIVRType . Mandatory. Once specified cannot be changed.

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

getVersion

public final java.lang.String getVersion()
A pointer to the version of the IVR. Mandatory.

Returns:
property value or null

setVersion

public final void setVersion(java.lang.String value)
A pointer to the version of the IVR. Mandatory.

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

getIVRServer

public final CfgApplication getIVRServer()
A unique identifier of the CfgApplication of CfgIVRInterfaceServer type permanently associated to serve this IVR.

Returns:
instance of referred object or null

setIVRServer

public final void setIVRServer(CfgApplication value)
A unique identifier of the CfgApplication of CfgIVRInterfaceServer type permanently associated to serve this IVR.

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

setIVRServerDBID

public final void setIVRServerDBID(int dbid)
A unique identifier of the CfgApplication of CfgIVRInterfaceServer type permanently associated to serve this IVR.

Parameters:
dbid - DBID identifier of referred object
See Also:
getIVRServer()

getIVRServerDBID

public final java.lang.Integer getIVRServerDBID()
Retrieves the dbid of the object that is being linked to by the IVRServer property.

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

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

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.