Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgSwitch

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

public class CfgSwitch
extends CfgObject

A Switch is an aggregate of telephony resources within a Switching Office.

Most enterprise-level configurations have a one-to-one match between switches and switching offices. However, there may be instances when it is desirable to partition an office into more than one switch, perhaps due to CTI_link capacity limitations, or to create a more efficient and secure numbering plan. In that case, you must define these switches within a switching office.

The current version of Configuration Server does not verify correspondence between the switch numbering plan defined by DNRange and the actual DN numbers defined within this switch by number in CfgDN . Such verification may be implemented in one of the next versions. In versions 5.1.1XX and earlier, it is users' responsibility to make sure the range covers all actual DNs of the switch in question.

Deletion of Switch X will cause the following events set out in the order of arrival:



See also:

CfgDeltaSwitch

CfgDN

CfgAgentLogin


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgSwitch(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgSwitch(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgSwitch(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
 
Method Summary
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 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.
 java.util.Collection<CfgSwitchAccessCode> getSwitchAccessCodes()
          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 ).
 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.
 KeyValueCollection getUserProperties()
          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.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDNRange(java.lang.String value)
          A pointer to a string that describes the numbering plan of the switch.
 void setLinkType(CfgLinkType value)
          Type of the CTI link of this switch.
 void setName(java.lang.String value)
          A pointer to the name of the switch.
 void setPhysSwitch(CfgPhysicalSwitch value)
          A unique identifier of the Physical Switch within which this switch is defined.
 void setPhysSwitchDBID(int dbid)
          A unique identifier of the Physical Switch within which this switch is defined.
 void setState(CfgObjectState value)
          Current object state.
 void setSwitchAccessCodes(java.util.Collection<CfgSwitchAccessCode> value)
          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 ).
 void setTenant(CfgTenant value)
          A unique identifier of the Tenant to which this switch is allocated.
 void setTenantDBID(int dbid)
          A unique identifier of the Tenant to which this switch is allocated.
 void setTServer(CfgApplication value)
          A unique identifier of the T-Server Application through which the telephony objects of this switch are controlled.
 void setTServerDBID(int dbid)
          A unique identifier of the T-Server Application through which the telephony objects of this switch are controlled.
 void setUserProperties(KeyValueCollection value)
          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.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, ensureDataBackup, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, update, 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, toStringProperties, 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
 

Field Detail

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgSwitch

public CfgSwitch(IConfService confService,
                 ConfObject objData,
                 boolean isSaved,
                 java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object data structure
isSaved - indicator of the object saved state
additionalParameters - additional parameters from configuration protocol message

CfgSwitch

public CfgSwitch(IConfService confService,
                 org.w3c.dom.Node xmlData,
                 java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object data
additionalParameters - additional parameters from configuration protocol message

CfgSwitch

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

Parameters:
confService - configuration service instance
Method Detail

save

public void save()
          throws ConfigException
Synchronizes changes in the class with Configuration Server.

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

getDBID

public final java.lang.Integer getDBID()
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Returns:
property value or null

setDBID

public final void setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Parameters:
value - new property value
See Also:
getDBID()

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

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the Tenant to which this switch is allocated. Mandatory. Once specified, cannot be changed.

Parameters:
value - new property value
See Also:
getTenant()

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the Tenant to which this switch is allocated. Mandatory. Once specified, cannot be changed.

Parameters:
dbid - DBID identifier of referred object
See Also:
getTenant()

getTenantDBID

public final java.lang.Integer getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property.

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

setPhysSwitch

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

Parameters:
value - new property value
See Also:
getPhysSwitch()

setPhysSwitchDBID

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

Parameters:
dbid - DBID identifier of referred object
See Also:
getPhysSwitch()

getPhysSwitchDBID

public final java.lang.Integer getPhysSwitchDBID()
Retrieves the dbid of the object that is being linked to by the PhysSwitch property.

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

setName

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

Parameters:
value - new property value
See Also:
getName()

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

setTServer

public final void setTServer(CfgApplication value)
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.

Parameters:
value - new property value
See Also:
getTServer()

setTServerDBID

public final void setTServerDBID(int dbid)
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.

Parameters:
dbid - DBID identifier of referred object
See Also:
getTServer()

getTServerDBID

public final java.lang.Integer getTServerDBID()
Retrieves the dbid of the object that is being linked to by the TServer property.

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

setLinkType

public final void setLinkType(CfgLinkType value)
Type of the CTI link of this switch. Optional. See CfgLinkType

Parameters:
value - new property value
See Also:
getLinkType()

getSwitchAccessCodes

public final java.util.Collection<CfgSwitchAccessCode> getSwitchAccessCodes()
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

setSwitchAccessCodes

public final void setSwitchAccessCodes(java.util.Collection<CfgSwitchAccessCode> value)
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.

Parameters:
value - new property value
See Also:
getSwitchAccessCodes()

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

setDNRange

public final void setDNRange(java.lang.String value)
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).

Parameters:
value - new property value
See Also:
getDNRange()

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

setState

public final void setState(CfgObjectState value)
Current object state. Mandatory. Refer to CfgObjectState

Parameters:
value - new property value
See Also:
getState()

getUserProperties

public final KeyValueCollection getUserProperties()
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

setUserProperties

public final void setUserProperties(KeyValueCollection value)
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.

Parameters:
value - new property value
See Also:
getUserProperties()

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.