Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaActionCode

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

public class CfgDeltaActionCode
extends CfgDelta

The changes to make to a CfgActionCode object.


Constructor Summary
CfgDeltaActionCode(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaActionCode(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaActionCode(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<CfgSubcode> getAddedSubcodes()
          A pointer to the list of the subcodes defined within the action code (every item of this list is structured as CfgSubcode ).
 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 getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.lang.String getCode()
          A pointer to the index or abbreviation of the action code.
 java.lang.Integer getDBID()
          The DBID of the target CfgActionCode configuration object.
 java.util.Collection<CfgSubcode> getDeletedSubcodes()
          A pointer to the list of names of the subcodes that are no longer defined within this action code (every item of this list has variable type char*).
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getName()
          A pointer to the name of the action code.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the Tenant that this action code belongs to.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgActionCodeType getType()
          Type of the action code.
 CfgActionCode retrieveCfgActionCode()
          Read base CfgActionCode 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

CfgDeltaActionCode

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

Parameters:
confService - configuration service instance

CfgDeltaActionCode

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

CfgDeltaActionCode

public CfgDeltaActionCode(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 CfgActionCode configuration object.

Returns:
target object DBID

retrieveCfgActionCode

public final CfgActionCode retrieveCfgActionCode()
                                          throws ConfigException
Read base CfgActionCode 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 Tenant that this action code belongs to. Mandatory. Once specified, cannot be changed.

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

getName

public final java.lang.String getName()
A pointer to the name of the action code. Mandatory. Must be unique within the action code type specified below for the given tenant.

Returns:
property value or null

getType

public final CfgActionCodeType getType()
Type of the action code. See type CfgActionCodeType. Mandatory. Once specified, cannot be changed.

Returns:
property value or null

getCode

public final java.lang.String getCode()
A pointer to the index or abbreviation of the action code. Mandatory. Must be unique within the action code type specified above for the given tenant.

Returns:
property value or null

getAddedSubcodes

public final java.util.Collection<CfgSubcode> getAddedSubcodes()
A pointer to the list of the subcodes defined within the action code (every item of this list is structured as CfgSubcode ). When used as an entry in CfgDeltaActionCode (see below), it is a pointer to a list of subcodes added to the existing list.

Returns:
list of structures 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

getDeletedSubcodes

public final java.util.Collection<CfgSubcode> getDeletedSubcodes()
A pointer to the list of names of the subcodes that are no longer defined within this action code (every item of this list has variable type char*).

Returns:
list of string values 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.