Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaAppPrototype

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

public class CfgDeltaAppPrototype
extends CfgDelta

The changes to make to a CfgAppPrototype object.

Changes made to the options of an application prototype will not affect application-specific options of the existing applications associated with this prototype.


Constructor Summary
CfgDeltaAppPrototype(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaAppPrototype(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaAppPrototype(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 KeyValueCollection getAddedOptions()
          A pointer to the list of application-specific configuration options with default values where appropriate (see the comments below).
 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.
 KeyValueCollection getChangedOptions()
          A pointer to the list of application-specific options whose values have been changed.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.lang.Integer getDBID()
          The DBID of the target CfgAppPrototype configuration object.
 KeyValueCollection getDeletedOptions()
          A pointer to the list of deleted application-specific options.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getName()
          A pointer to the name of the application prototype.
 CfgObjectState getState()
          Current object state.
 CfgAppType getType()
          Type of the application.
 java.lang.String getVersion()
          A pointer to the application version.
 CfgAppPrototype retrieveCfgAppPrototype()
          Read base CfgAppPrototype 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

CfgDeltaAppPrototype

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

Parameters:
confService - configuration service instance

CfgDeltaAppPrototype

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

CfgDeltaAppPrototype

public CfgDeltaAppPrototype(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 CfgAppPrototype configuration object.

Returns:
target object DBID

retrieveCfgAppPrototype

public final CfgAppPrototype retrieveCfgAppPrototype()
                                              throws ConfigException
Read base CfgAppPrototype configuration object caused this event.

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

getName

public final java.lang.String getName()
A pointer to the name of the application prototype. Mandatory. Once specified, cannot be changed. Must be unique within the Configuration Database.

Returns:
property value or null

getType

public final CfgAppType getType()
Type of the application. Mandatory. Once specified, cannot be changed. See CfgAppType .

Returns:
property value or null

getVersion

public final java.lang.String getVersion()
A pointer to the application version. Once specified, cannot be changed.

Returns:
property value or null

getAddedOptions

public final KeyValueCollection getAddedOptions()
A pointer to the list of application-specific configuration options with default values where appropriate (see the comments below). When used as an entry in CfgDeltaApplication, it is a pointer to a list of options added to the existing list.

Returns:
property value or null

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

getDeletedOptions

public final KeyValueCollection getDeletedOptions()
A pointer to the list of deleted application-specific options. The structure of this parameter is described in the comments to type CfgAppPrototype above. An option is deleted by specifying the name of the section that this option belongs to, and the name of the option itself with any value. A whole section is deleted by specifying the name of that section and an empty secondary list.

Returns:
property value or null

getChangedOptions

public final KeyValueCollection getChangedOptions()
A pointer to the list of application-specific options whose values have been changed. The structure of this parameter is described in the comments to type CfgAppPrototype above. A value of an option is changed by specifying the name of the section that this option belongs to, the name of the option itself, and the new value of that option.

Returns:
property value 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

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.