|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgBase
com.genesyslab.platform.applicationblocks.com.CfgObject
com.genesyslab.platform.applicationblocks.com.objects.CfgSwitch
public class CfgSwitch
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:
switchAccessCodes
of all switches
that were interfaced with Switch X
switchDBID
field
set to Switch X
accessNumbers
of all DNs which
were connected with Switch X
flexibleProperties
of all T-Servers
which were connected with Switch X
CfgDN
for
details)
CfgAgentLogin
for details)
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgSwitch(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
confService
- configuration service instanceobjData
- configuration protocol object data structureisSaved
- indicator of the object saved stateadditionalParameters
- additional parameters from configuration protocol messagepublic CfgSwitch(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
confService
- configuration service instancexmlData
- XML object containing object dataadditionalParameters
- additional parameters from configuration protocol messagepublic CfgSwitch(IConfService confService)
confService
- configuration service instanceMethod Detail |
---|
public void save() throws ConfigException
save
in interface ICfgObject
save
in class CfgObject
ConfigException
- in case of protocol level exception, data transformation,
or server side constraintspublic final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final CfgTenant getTenant()
Tenant
to which this switch is allocated. Mandatory. Once specified,
cannot be changed.
public final void setTenant(CfgTenant value)
Tenant
to which this switch is allocated. Mandatory. Once specified,
cannot be changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
Tenant
to which this switch is allocated. Mandatory. Once specified,
cannot be changed.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final CfgPhysicalSwitch getPhysSwitch()
Physical Switch
within which this
switch is defined. Mandatory. Once specified, cannot be changed.
public final void setPhysSwitch(CfgPhysicalSwitch value)
Physical Switch
within which this
switch is defined. Mandatory. Once specified, cannot be changed.
value
- new property valuegetPhysSwitch()
public final void setPhysSwitchDBID(int dbid)
Physical Switch
within which this
switch is defined. Mandatory. Once specified, cannot be changed.
dbid
- DBID identifier of referred objectgetPhysSwitch()
public final java.lang.Integer getPhysSwitchDBID()
public final CfgSwitchType getType()
type
of the physical switch specified in physSwitchDBID
).
See
CfgSwitchType
.
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final CfgApplication getTServer()
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.
public final void setTServer(CfgApplication value)
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.
value
- new property valuegetTServer()
public final void setTServerDBID(int dbid)
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.
dbid
- DBID identifier of referred objectgetTServer()
public final java.lang.Integer getTServerDBID()
public final CfgLinkType getLinkType()
CfgLinkType
public final void setLinkType(CfgLinkType value)
CfgLinkType
value
- new property valuegetLinkType()
public final java.util.Collection<CfgSwitchAccessCode> getSwitchAccessCodes()
CfgSwitchAccessCode
). When used as an entry
in
CfgDeltaSwitch
, it is a pointer to a list of switch access
codes added to the existing list.
public final void setSwitchAccessCodes(java.util.Collection<CfgSwitchAccessCode> value)
CfgSwitchAccessCode
). When used as an entry
in
CfgDeltaSwitch
, it is a pointer to a list of switch access
codes added to the existing list.
value
- new property valuegetSwitchAccessCodes()
public final java.lang.String getDNRange()
1100-1179, 1190-1195, 1199
).
public final void setDNRange(java.lang.String value)
1100-1179, 1190-1195, 1199
).
value
- new property valuegetDNRange()
public final CfgObjectState getState()
CfgObjectState
public final void setState(CfgObjectState value)
CfgObjectState
value
- new property valuegetState()
public final KeyValueCollection getUserProperties()
public final void setUserProperties(KeyValueCollection value)
value
- new property valuegetUserProperties()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |