Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaGVPIVRProfile

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.CfgDelta
              extended by com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaGVPIVRProfile
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaGVPIVRProfile
extends CfgDelta

The changes to make to a CfgGVPIVRProfile object.


Constructor Summary
CfgDeltaGVPIVRProfile(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaGVPIVRProfile(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaGVPIVRProfile(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 java.util.Collection<java.lang.Integer> getAddedDIDDBIDs()
          This property is obsolete and is not in use.
 java.util.Collection<CfgDN> getAddedDIDs()
          This property is obsolete and is not in use.
 java.util.Collection<CfgObjectResource> getAddedResources()
           
 KeyValueCollection getAddedUserProperties()
          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.util.Collection<CfgObjectResource> getChangedResources()
           
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 CfgGVPCustomer getCustomer()
          This property is obsolete and is not in use.
 java.lang.Integer getCustomerDBID()
          Retrieves the dbid of the object that is being linked to by the Customer property.
 java.lang.Integer getDBID()
          The DBID of the target CfgGVPIVRProfile configuration object.
 java.util.Collection<java.lang.Integer> getDeletedDIDDBIDs()
          A pointer to the list of deleted DNs.
 java.util.Collection<CfgDN> getDeletedDIDs()
          A pointer to the list of deleted DNs.
 java.util.Collection<CfgResourceID> getDeletedResources()
           
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          An optional short description of this GVP Voice Application Profile.
 java.util.Collection<java.lang.Integer> getDIDDBIDs()
          Deprecated.  
 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.lang.Integer getResellerDBID()
          Retrieves the dbid of the object that is being linked to by the Reseller property.
 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.
 CfgGVPIVRProfile retrieveCfgGVPIVRProfile()
          Read base CfgGVPIVRProfile configuration object caused this event.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgDelta
ensureDataBackup, retrieveObject, save, toStringProperties, update
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, 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, 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
 

Constructor Detail

CfgDeltaGVPIVRProfile

public CfgDeltaGVPIVRProfile(IConfService confService)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance

CfgDeltaGVPIVRProfile

public CfgDeltaGVPIVRProfile(IConfService confService,
                             ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object delta data

CfgDeltaGVPIVRProfile

public CfgDeltaGVPIVRProfile(IConfService confService,
                             org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object delta data
Method Detail

getDBID

public final java.lang.Integer getDBID()
The DBID of the target CfgGVPIVRProfile configuration object.

Returns:
target object DBID

retrieveCfgGVPIVRProfile

public final CfgGVPIVRProfile retrieveCfgGVPIVRProfile()
                                                throws ConfigException
Read base CfgGVPIVRProfile configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

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

getTenantDBID

public final java.lang.Integer getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. Configuration server provides it only if the property value has been changed.

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

getCustomerDBID

public final java.lang.Integer getCustomerDBID()
Retrieves the dbid of the object that is being linked to by the Customer property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier 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

getResellerDBID

public final java.lang.Integer getResellerDBID()
Retrieves the dbid of the object that is being linked to by the Reseller property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier 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

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

getType

public final CfgIVRProfileType getType()
This property is obsolete.

Returns:
property value or null

getNotes

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

Returns:
property value or null

getDescription

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

Returns:
property value or null

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

getAddedDIDs

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

Returns:
list of configuration objects or null

getAddedDIDDBIDs

public final java.util.Collection<java.lang.Integer> getAddedDIDDBIDs()
This property is obsolete and is not in use.

Returns:
collection of DBID identifiers of referred objects or null

getDIDDBIDs

@Deprecated
public final java.util.Collection<java.lang.Integer> getDIDDBIDs()
Deprecated. 

See Also:
getAddedDIDDBIDs()

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

getAddedUserProperties

public final KeyValueCollection getAddedUserProperties()
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

getAddedResources

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

getDeletedDIDs

public final java.util.Collection<CfgDN> getDeletedDIDs()
A pointer to the list of deleted DNs.

Returns:
list of configuration objects or null

getDeletedDIDDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedDIDDBIDs()
A pointer to the list of deleted DNs.

Returns:
collection of DBID identifiers of referred objects or null

getDeletedUserProperties

public final KeyValueCollection getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. Has the same structure as parameter userProperties.

Returns:
property value or null

getChangedUserProperties

public final KeyValueCollection getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. Has the same structure as parameter userProperties

Returns:
property value or null

getDeletedResources

public final java.util.Collection<CfgResourceID> getDeletedResources()

getChangedResources

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

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.