|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgBase
com.genesyslab.platform.applicationblocks.com.CfgObject
com.genesyslab.platform.applicationblocks.com.objects.CfgIVR
public class CfgIVR
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:
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgIVR(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
confService
- configuration service instanceobjData
- configuration protocol object data structureisSaved
- indicator of the object saved stateadditionalParameters
- additional parameters from configuration protocol messagepublic CfgIVR(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
confService
- configuration service instancexmlData
- XML object containing object dataadditionalParameters
- additional parameters from configuration protocol messagepublic CfgIVR(IConfService confService)
confService
- configuration service instanceMethod Detail |
---|
public void save() throws ConfigException
save
in interface ICfgObject
save
in class CfgObject
ConfigException
- in case of protocol level exception, data transformation,
or server side constraintspublic final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final CfgTenant getTenant()
CfgTenant
to which this IVR belongs. Once specified cannot be changed.
public final void setTenant(CfgTenant value)
CfgTenant
to which this IVR belongs. Once specified cannot be changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
CfgTenant
to which this IVR belongs. Once specified cannot be changed.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
value
- new property valuegetDescription()
public final CfgIVRType getType()
CfgIVRType
.
Mandatory. Once specified cannot be changed.
public final void setType(CfgIVRType value)
CfgIVRType
.
Mandatory. Once specified cannot be changed.
value
- new property valuegetType()
public final java.lang.String getVersion()
public final void setVersion(java.lang.String value)
value
- new property valuegetVersion()
public final CfgApplication getIVRServer()
CfgApplication
of CfgIVRInterfaceServer
type permanently
associated to serve this IVR.
public final void setIVRServer(CfgApplication value)
CfgApplication
of CfgIVRInterfaceServer
type permanently
associated to serve this IVR.
value
- new property valuegetIVRServer()
public final void setIVRServerDBID(int dbid)
CfgApplication
of CfgIVRInterfaceServer
type permanently
associated to serve this IVR.
dbid
- DBID identifier of referred objectgetIVRServer()
public final java.lang.Integer getIVRServerDBID()
public final CfgObjectState getState()
CfgObjectState
public final void setState(CfgObjectState value)
CfgObjectState
value
- new property valuegetState()
public final KeyValueCollection getUserProperties()
public final void setUserProperties(KeyValueCollection value)
value
- new property valuegetUserProperties()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |