|
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.CfgIVRPort
public class CfgIVRPort
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.
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgIVRPort(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 CfgIVRPort(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 CfgIVRPort(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 port belongs. Read-only (set automatically according
to the current value of
tenantDBID
of the IVR specified in IVRDBID
).
See type
CfgIVR
.
public final void setTenant(CfgTenant value)
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
.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
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
.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final java.lang.String getPortNumber()
public final void setPortNumber(java.lang.String value)
value
- new property valuegetPortNumber()
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
value
- new property valuegetDescription()
public final CfgIVR getIVR()
CfgIVR
this
IVR port belongs to. Mandatory. Once specified, can not be changed
public final void setIVR(CfgIVR value)
CfgIVR
this
IVR port belongs to. Mandatory. Once specified, can not be changed
value
- new property valuegetIVR()
public final void setIVRDBID(int dbid)
CfgIVR
this
IVR port belongs to. Mandatory. Once specified, can not be changed
dbid
- DBID identifier of referred objectgetIVR()
public final java.lang.Integer getIVRDBID()
public final CfgDN getDN()
CfgDN
associated
with this IVR port.
public final void setDN(CfgDN value)
CfgDN
associated
with this IVR port.
value
- new property valuegetDN()
public final void setDNDBID(int dbid)
CfgDN
associated
with this IVR port.
dbid
- DBID identifier of referred objectgetDN()
public final java.lang.Integer getDNDBID()
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 |