Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgIVRPort

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

public class CfgIVRPort
extends CfgObject

An Interactive Voice Response (IVR) Port is a telephony object uniquely identified by the numbers within an IVR at which telephone calls may reside and be handled.

An IVR port can only be associated with one IVR.

See also:

CfgDeltaIVRPort

CfgIVR

CfgDN


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgIVRPort(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgIVRPort(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgIVRPort(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 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.
 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.
 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 string describing IVR port.
 void setDN(CfgDN value)
          A unique identifier of CfgDN associated with this IVR port.
 void setDNDBID(int dbid)
          A unique identifier of CfgDN associated with this IVR port.
 void setIVR(CfgIVR value)
          A unique identifier of CfgIVR this IVR port belongs to.
 void setIVRDBID(int dbid)
          A unique identifier of CfgIVR this IVR port belongs to.
 void setPortNumber(java.lang.String value)
          A pointer to the string, representing number associated with channel on IVR.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the CfgTenant to which this IVR port belongs.
 void setTenantDBID(int dbid)
          A unique identifier of the CfgTenant to which this IVR port belongs.
 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.
 
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

CfgIVRPort

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

CfgIVRPort

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

CfgIVRPort

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

setTenant

public final void setTenant(CfgTenant value)
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 .

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

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

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

setPortNumber

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

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

getDescription

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

Returns:
property value or null

setDescription

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

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

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

setIVR

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

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

setIVRDBID

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

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

getIVRDBID

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

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

setDN

public final void setDN(CfgDN value)
A unique identifier of CfgDN associated with this IVR port.

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

setDNDBID

public final void setDNDBID(int dbid)
A unique identifier of CfgDN associated with this IVR port.

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

getDNDBID

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