|
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.CfgGVPIVRProfile
public class CfgGVPIVRProfile
A GVP Voice Application Profile is used by a GVP to define an voice application that can be executed upon request. Each GVP Voice Application is associated with one Tenant.
Field Summary | |
---|---|
static CfgObjectType |
OBJECT_TYPE
|
Constructor Summary | |
---|---|
CfgGVPIVRProfile(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgGVPIVRProfile(IConfService confService,
ConfObject objData,
boolean isSaved,
java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. |
|
CfgGVPIVRProfile(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 | |
---|---|
CfgGVPCustomer |
getCustomer()
This property is obsolete and is not in use. |
java.lang.Integer |
getDBID()
An identifier of this object in the Configuration Database. |
java.lang.String |
getDescription()
An optional short description of this GVP Voice Application Profile. |
java.util.Collection<java.lang.Integer> |
getDIDDBIDs()
Retrieves dbids of objects that are being linked to by the DIDs property. |
java.util.Collection<CfgDN> |
getDIDs()
This property is obsolete and is not in use. |
java.lang.String |
getDisplayName()
A name for this GVP IVR Profile that appears on the console display. |
java.util.Calendar |
getEndServiceDate()
The date when this GVP IVR Profile ends. |
CfgFlag |
getIsProvisioned()
This property is obsolete. |
java.lang.String |
getName()
A pointer to name of the GVP Voice Application Profile. |
java.lang.String |
getNotes()
Optional notes and information relevant for this GVP Voice Application Profile. |
CfgGVPReseller |
getReseller()
This property is obsolete and is not in use. |
java.util.Collection<CfgObjectResource> |
getResources()
|
java.util.Calendar |
getStartServiceDate()
This property is obsolete. |
CfgObjectState |
getState()
Current object state. |
java.lang.String |
getStatus()
This property is obsolete. |
CfgTenant |
getTenant()
A unique identifier of the
CfgTenant
to which this GVP Voice Application Profile is allocated. |
java.lang.Integer |
getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. |
java.lang.String |
getTfn()
This property is obsolete. |
CfgIVRProfileType |
getType()
This property is obsolete. |
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)
An optional short description of this GVP Voice Application Profile. |
void |
setDIDDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the DIDs property. |
void |
setDIDs(java.util.Collection<CfgDN> value)
This property is obsolete and is not in use. |
void |
setDisplayName(java.lang.String value)
A name for this GVP IVR Profile that appears on the console display. |
void |
setName(java.lang.String value)
A pointer to name of the GVP Voice Application Profile. |
void |
setNotes(java.lang.String value)
Optional notes and information relevant for this GVP Voice Application Profile. |
void |
setResources(java.util.Collection<CfgObjectResource> value)
|
void |
setState(CfgObjectState value)
Current object state. |
void |
setTenant(CfgTenant value)
A unique identifier of the
CfgTenant
to which this GVP Voice Application Profile is allocated. |
void |
setTenantDBID(int dbid)
A unique identifier of the
CfgTenant
to which this GVP Voice Application Profile is allocated. |
void |
setType(CfgIVRProfileType value)
This property is obsolete. |
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 CfgGVPIVRProfile(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 CfgGVPIVRProfile(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 CfgGVPIVRProfile(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 GVP Voice Application Profile is allocated. Populated upon creaton. Read-only
public final void setTenant(CfgTenant value)
CfgTenant
to which this GVP Voice Application Profile is allocated. Populated upon creaton. Read-only
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
CfgTenant
to which this GVP Voice Application Profile is allocated. Populated upon creaton. Read-only
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final CfgGVPCustomer getCustomer()
public final CfgGVPReseller getReseller()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final java.lang.String getDisplayName()
public final void setDisplayName(java.lang.String value)
value
- new property valuegetDisplayName()
public final CfgIVRProfileType getType()
public final void setType(CfgIVRProfileType value)
value
- new property valuegetType()
public final java.lang.String getNotes()
public final void setNotes(java.lang.String value)
value
- new property valuegetNotes()
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
value
- new property valuegetDescription()
public final java.util.Calendar getStartServiceDate()
public final java.util.Calendar getEndServiceDate()
public final CfgFlag getIsProvisioned()
public final java.lang.String getTfn()
public final java.lang.String getStatus()
public final java.util.Collection<CfgDN> getDIDs()
public final void setDIDs(java.util.Collection<CfgDN> value)
value
- new property valuegetDIDs()
public final java.util.Collection<java.lang.Integer> getDIDDBIDs()
public final void setDIDDBIDs(java.util.Collection<java.lang.Integer> value)
value
- collection of DBID identifiers of referred objectspublic 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()
public final java.util.Collection<CfgObjectResource> getResources()
public final void setResources(java.util.Collection<CfgObjectResource> value)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |