|
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.CfgVoicePrompt
public class CfgVoicePrompt
Voice Prompts are call treatment objects that may include a set of actions to be applied to a called party. Common/System Voice Prompts have to be located under \Environment \ Voice Prompts folders. The System Voice Prompts is available for all applications. Tenant-specific Voice Prompts have to be located under
\
Voice Prompts
folders. The access to these prompts have only
configuration objects with access permissions to this tenant only.
Field Summary | |
---|---|
static CfgObjectType |
OBJECT_TYPE
|
Constructor Summary | |
---|---|
CfgVoicePrompt(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgVoicePrompt(IConfService confService,
ConfObject objData,
boolean isSaved,
java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. |
|
CfgVoicePrompt(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 voice prompt description. |
java.lang.String |
getName()
A pointer to the voice prompt name that identifies the voice prompt. |
CfgScript |
getScript()
A unique identifier of the
CfgScript
for this voice prompt. |
java.lang.Integer |
getScriptDBID()
Retrieves the dbid of the object that is being linked to by the Script property. |
CfgObjectState |
getState()
Current object state. |
CfgSwitch |
getSwitch()
A unique identifier of the
CfgSwitch
to which this voice prompt belongs. |
java.lang.Integer |
getSwitchDBID()
Retrieves the dbid of the object that is being linked to by the Switch property. |
CfgTenant |
getTenant()
A unique identifier of the
CfgTenant
to which this voice prompt is allocated. |
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 voice prompt description. |
void |
setName(java.lang.String value)
A pointer to the voice prompt name that identifies the voice prompt. |
void |
setScript(CfgScript value)
A unique identifier of the
CfgScript
for this voice prompt. |
void |
setScriptDBID(int dbid)
A unique identifier of the
CfgScript
for this voice prompt. |
void |
setState(CfgObjectState value)
Current object state. |
void |
setSwitch(CfgSwitch value)
A unique identifier of the
CfgSwitch
to which this voice prompt belongs. |
void |
setSwitchDBID(int dbid)
A unique identifier of the
CfgSwitch
to which this voice prompt belongs. |
void |
setTenant(CfgTenant value)
A unique identifier of the
CfgTenant
to which this voice prompt is allocated. |
void |
setTenantDBID(int dbid)
A unique identifier of the
CfgTenant
to which this voice prompt is allocated. |
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 CfgVoicePrompt(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 CfgVoicePrompt(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 CfgVoicePrompt(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 CfgSwitch getSwitch()
CfgSwitch
to which this voice prompt belongs. Optional.
public final void setSwitch(CfgSwitch value)
CfgSwitch
to which this voice prompt belongs. Optional.
value
- new property valuegetSwitch()
public final void setSwitchDBID(int dbid)
CfgSwitch
to which this voice prompt belongs. Optional.
dbid
- DBID identifier of referred objectgetSwitch()
public final java.lang.Integer getSwitchDBID()
public final CfgTenant getTenant()
CfgTenant
to which this voice prompt is allocated. Read only.
public final void setTenant(CfgTenant value)
CfgTenant
to which this voice prompt is allocated. Read only.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
CfgTenant
to which this voice prompt is allocated. Read only.
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 CfgScript getScript()
CfgScript
for this voice prompt.
public final void setScript(CfgScript value)
CfgScript
for this voice prompt.
value
- new property valuegetScript()
public final void setScriptDBID(int dbid)
CfgScript
for this voice prompt.
dbid
- DBID identifier of referred objectgetScript()
public final java.lang.Integer getScriptDBID()
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 |