Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaField

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

public class CfgDeltaField
extends CfgDelta

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


Constructor Summary
CfgDeltaField(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaField(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaField(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 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 CfgField configuration object.
 java.lang.String getDefaultValue()
          A pointer to the default value of field.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDescription()
          A pointer to the description of field.
 CfgFieldType getFieldType()
          A field type.
 CfgFlag getIsNullable()
          A flag which determines whether or not a field can allow null values ( NULLs ) for the data in that field.
 CfgFlag getIsPrimaryKey()
          A flag which determines whether or not a field is used as primary key.
 CfgFlag getIsUnique()
          A flag which determines whether or not a field is used as unique.
 java.lang.Integer getLength()
          A length of field in data base.
 java.lang.String getName()
          A field name in data base.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the CfgTenant that this field belongs to.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgDataType getType()
          A data type of field in data base.
 CfgField retrieveCfgField()
          Read base CfgField 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

CfgDeltaField

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

Parameters:
confService - configuration service instance

CfgDeltaField

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

CfgDeltaField

public CfgDeltaField(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 CfgField configuration object.

Returns:
target object DBID

retrieveCfgField

public final CfgField retrieveCfgField()
                                throws ConfigException
Read base CfgField 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 that this field 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 field name in data base. 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

getType

public final CfgDataType getType()
A data type of field in data base. Mandatory, once specified cannot be changed. See CfgDataType

Returns:
property value or null

getDescription

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

Returns:
property value or null

getLength

public final java.lang.Integer getLength()
A length of field in data base. Optional, once specified cannot be changed.

Returns:
property value or null

getFieldType

public final CfgFieldType getFieldType()
A field type. Refer to CfgFieldType of User Defined Variable types. Mandatory, once specified cannot be changed.

Returns:
property value or null

getDefaultValue

public final java.lang.String getDefaultValue()
A pointer to the default value of field. Specify what value to insert when a user does not enter a value. Optional.

Returns:
property value or null

getIsPrimaryKey

public final CfgFlag getIsPrimaryKey()
A flag which determines whether or not a field is used as primary key. Once specified cannot be changed. See CfgFlag

Returns:
property value or null

getIsUnique

public final CfgFlag getIsUnique()
A flag which determines whether or not a field is used as unique. Once specified cannot be changed. See CfgFlag

Returns:
property value or null

getIsNullable

public final CfgFlag getIsNullable()
A flag which determines whether or not a field can allow null values ( NULLs ) for the data in that field. Once specified cannot be changed. See CfgFlag

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

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.