Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaSwitch

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

public class CfgDeltaSwitch
extends CfgDelta

The changes to make to a CfgSwitch object.


Constructor Summary
CfgDeltaSwitch(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaSwitch(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaSwitch(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<CfgSwitchAccessCode> getAddedSwitchAccessCodes()
          A pointer to the list of access codes of the switches that this switch can access (every item of this list is structured as CfgSwitchAccessCode ).
 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 CfgSwitch configuration object.
 java.util.Collection<CfgSwitchAccessCode> getDeletedSwitchAccessCodes()
          A pointer to the list of deleted switch access codes (every item of this list is structured as CfgSwitchAccessCode ).
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.lang.String getDNRange()
          A pointer to a string that describes the numbering plan of the switch.
 CfgLinkType getLinkType()
          Type of the CTI link of this switch.
 java.lang.String getName()
          A pointer to the name of the switch.
 CfgPhysicalSwitch getPhysSwitch()
          A unique identifier of the Physical Switch within which this switch is defined.
 java.lang.Integer getPhysSwitchDBID()
          Retrieves the dbid of the object that is being linked to by the PhysSwitch property.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the Tenant to which this switch is allocated.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 CfgApplication getTServer()
          A unique identifier of the T-Server Application through which the telephony objects of this switch are controlled.
 java.lang.Integer getTServerDBID()
          Retrieves the dbid of the object that is being linked to by the TServer property.
 CfgSwitchType getType()
          Type of the physical switch to which this switch belongs.
 CfgSwitch retrieveCfgSwitch()
          Read base CfgSwitch 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

CfgDeltaSwitch

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

Parameters:
confService - configuration service instance

CfgDeltaSwitch

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

CfgDeltaSwitch

public CfgDeltaSwitch(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 CfgSwitch configuration object.

Returns:
target object DBID

retrieveCfgSwitch

public final CfgSwitch retrieveCfgSwitch()
                                  throws ConfigException
Read base CfgSwitch 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 to which this switch 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

getPhysSwitch

public final CfgPhysicalSwitch getPhysSwitch()
A unique identifier of the Physical Switch within which this switch is defined. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

getPhysSwitchDBID

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

Returns:
DBID identifier of referred object or null

getType

public final CfgSwitchType getType()
Type of the physical switch to which this switch belongs. Read-only (set automatically according to the current value of type of the physical switch specified in physSwitchDBID). See CfgSwitchType .

Returns:
property value or null

getName

public final java.lang.String getName()
A pointer to the name of the switch. Mandatory. Must be unique within the tenant and the physical switch.

Returns:
property value or null

getTServer

public final CfgApplication getTServer()
A unique identifier of the T-Server Application through which the telephony objects of this switch are controlled. Parameter tenantDBIDs of the T-Server must be specified and match the setting of tenantDBID of this switch. One T-Server cannot be associated with more than one switch unless the switch is of type CFGMultimediaSwitch. The property is applicable for 5.1 applications only, for compatibility. Starting from release 6.0 the association between T-Server and switch have to be configured using CfgApplication (T-Server) object. See flexibleProperties in CfgApplication.

Returns:
instance of referred object or null

getTServerDBID

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

Returns:
DBID identifier of referred object or null

getLinkType

public final CfgLinkType getLinkType()
Type of the CTI link of this switch. Optional. See CfgLinkType

Returns:
property value or null

getAddedSwitchAccessCodes

public final java.util.Collection<CfgSwitchAccessCode> getAddedSwitchAccessCodes()
A pointer to the list of access codes of the switches that this switch can access (every item of this list is structured as CfgSwitchAccessCode ). When used as an entry in CfgDeltaSwitch , it is a pointer to a list of switch access codes added to the existing list.

Returns:
list of structures or null

getDNRange

public final java.lang.String getDNRange()
A pointer to a string that describes the numbering plan of the switch. Use a hyphen to specify a range of numbers; use commas to specify a series of stand-alone numbers or ranges (e.g., 1100-1179, 1190-1195, 1199).

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

getDeletedSwitchAccessCodes

public final java.util.Collection<CfgSwitchAccessCode> getDeletedSwitchAccessCodes()
A pointer to the list of deleted switch access codes (every item of this list is structured as CfgSwitchAccessCode ).

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