Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaFormat

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

public class CfgDeltaFormat
extends CfgDelta

The CfgDeltaFormat is applicable for Configuration Library/Server release 5.1.5xx and later.


Constructor Summary
CfgDeltaFormat(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaFormat(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaFormat(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> getAddedFieldDBIDs()
          A pointer to the list of identifiers of CfgField objects that this format consists of.
 java.util.Collection<CfgField> getAddedFields()
          A pointer to the list of identifiers of CfgField objects that this format consists of.
 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.Integer getDBID()
          The DBID of the target CfgFormat configuration object.
 java.util.Collection<java.lang.Integer> getDeletedFieldDBIDs()
          A pointer to the list of deleted fields.
 java.util.Collection<CfgField> getDeletedFields()
          A pointer to the list of deleted fields.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          A pointer to the description of format.
 java.util.Collection<java.lang.Integer> getFieldDBIDs()
          Deprecated.  
 java.lang.String getName()
          A pointer to the name of the format.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant to which this format is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgFormat retrieveCfgFormat()
          Read base CfgFormat 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

CfgDeltaFormat

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

Parameters:
confService - configuration service instance

CfgDeltaFormat

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

CfgDeltaFormat

public CfgDeltaFormat(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 CfgFormat configuration object.

Returns:
target object DBID

retrieveCfgFormat

public final CfgFormat retrieveCfgFormat()
                                  throws ConfigException
Read base CfgFormat 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 format is allocated. 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 format. Due to restrictions of database engine the recommended length for property name is 1-12 characters. Mandatory, once specified cannot be changed.

Returns:
property value or null

getDescription

public final java.lang.String getDescription()
A pointer to the description of format.

Returns:
property value or null

getAddedFields

public final java.util.Collection<CfgField> getAddedFields()
A pointer to the list of identifiers of CfgField objects that this format consists of.

Returns:
list of configuration objects or null

getAddedFieldDBIDs

public final java.util.Collection<java.lang.Integer> getAddedFieldDBIDs()
A pointer to the list of identifiers of CfgField objects that this format consists of.

Returns:
collection of DBID identifiers of referred objects or null

getFieldDBIDs

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

See Also:
getAddedFieldDBIDs()

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

getDeletedFields

public final java.util.Collection<CfgField> getDeletedFields()
A pointer to the list of deleted fields.

Returns:
list of configuration objects or null

getDeletedFieldDBIDs

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

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

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.