Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgGVPIVRProfile

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

public class CfgGVPIVRProfile
extends CfgObject

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. Specified CfgGVPIVRProfile is not found (change/delete) CfgGVPIVRProfile already exists (Add) submited CfgGVPIVRProfile does not have any or all of mandatory fields filled (add/change)

See also:

CfgDeltaGVPIVRProfile


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

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgGVPIVRProfile

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

CfgGVPIVRProfile

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

CfgGVPIVRProfile

public CfgGVPIVRProfile(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 GVP Voice Application Profile is allocated. Populated upon creaton. Read-only

Returns:
instance of referred object or null

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the CfgTenant to which this GVP Voice Application Profile is allocated. Populated upon creaton. Read-only

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

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the CfgTenant to which this GVP Voice Application Profile is allocated. Populated upon creaton. Read-only

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

getCustomer

public final CfgGVPCustomer getCustomer()
This property is obsolete and is not in use.

Returns:
instance of referred object or null

getReseller

public final CfgGVPReseller getReseller()
This property is obsolete and is not in use.

Returns:
instance of referred object or null

getName

public final java.lang.String getName()
A pointer to name of the GVP Voice Application Profile. Mandatory. Must be unique within the Tenant.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to name of the GVP Voice Application Profile. Mandatory. Must be unique within the Tenant.

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

getDisplayName

public final java.lang.String getDisplayName()
A name for this GVP IVR Profile that appears on the console display.

Returns:
property value or null

setDisplayName

public final void setDisplayName(java.lang.String value)
A name for this GVP IVR Profile that appears on the console display.

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

getType

public final CfgIVRProfileType getType()
This property is obsolete.

Returns:
property value or null

setType

public final void setType(CfgIVRProfileType value)
This property is obsolete.

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

getNotes

public final java.lang.String getNotes()
Optional notes and information relevant for this GVP Voice Application Profile.

Returns:
property value or null

setNotes

public final void setNotes(java.lang.String value)
Optional notes and information relevant for this GVP Voice Application Profile.

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

getDescription

public final java.lang.String getDescription()
An optional short description of this GVP Voice Application Profile.

Returns:
property value or null

setDescription

public final void setDescription(java.lang.String value)
An optional short description of this GVP Voice Application Profile.

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

getStartServiceDate

public final java.util.Calendar getStartServiceDate()
This property is obsolete.

Returns:
property value or null

getEndServiceDate

public final java.util.Calendar getEndServiceDate()
The date when this GVP IVR Profile ends. This date must be the same as, or later than, the Start of Service.

Returns:
property value or null

getIsProvisioned

public final CfgFlag getIsProvisioned()
This property is obsolete.

Returns:
property value or null

getTfn

public final java.lang.String getTfn()
This property is obsolete.

Returns:
property value or null

getStatus

public final java.lang.String getStatus()
This property is obsolete.

Returns:
property value or null

getDIDs

public final java.util.Collection<CfgDN> getDIDs()
This property is obsolete and is not in use.

Returns:
list of configuration objects or null

setDIDs

public final void setDIDs(java.util.Collection<CfgDN> value)
This property is obsolete and is not in use.

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

getDIDDBIDs

public final java.util.Collection<java.lang.Integer> getDIDDBIDs()
Retrieves dbids of objects that are being linked to by the DIDs property. It's a snapshot collection containing original values. Modification of this collection instance will not affect actual value of the objects' property.

Returns:
collection of DBID identifiers of referred objects or null

setDIDDBIDs

public final void setDIDDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the DIDs property.

Parameters:
value - collection of DBID identifiers of referred objects

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()

getResources

public final java.util.Collection<CfgObjectResource> getResources()

setResources

public final void setResources(java.util.Collection<CfgObjectResource> value)

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.