Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgSwitchAccessCode

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgStructure
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgSwitchAccessCode
All Implemented Interfaces:
ICfgBase, ICfgStructure

public class CfgSwitchAccessCode
extends CfgStructure

CfgSwitchAccessCode contains a list of Access Codes that are used to place, route, or transfer calls from its Switch to other Switches in a multi-site installation.

Depending on the structure of a numbering plan, you may or may not need access codes to reach DNs that belong to different Switches of a multi-site telephone network.

You can modify (that is, create, change, or delete) the contents of the Access Codes for a particular Switch or for a set of Switches.

Uniqueness of a switch access code is defined by the combination of values of its first three properties, i.e., switchDBID, accessCode, and targetType. Thus, when a certain access code is to be deleted, it is necessary and sufficient to specify those three parameters in the corresponding item of the deletedSwitchAccessCodes list in CfgDeltaSwitch.

Function TRouteCall is a function of the T-Library and is defined in the T-Library SDK C Developer's Guide.

See also CfgSwitch .

If targetType=CFGTargetISCC the dnSource property is used for definition of ISCC protocol parameters and presented on GUI (Configuration Manager) with caption _ISCC Protocol Parameters_.

If targetType=CFGTargetISCC the destinationSource property is used for definition of ISCC call overflow parameters and presented on GUI (Configuration Manager) with caption _ISCC Call Overflow Parameters_.


Constructor Summary
CfgSwitchAccessCode(IConfService confService, ConfStructure objData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
CfgSwitchAccessCode(IConfService confService, ICfgObject parent)
          This constructor is intended for creation of detached objects.
CfgSwitchAccessCode(IConfService confService, org.w3c.dom.Node xmlData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
 
Method Summary
 java.lang.String getAccessCode()
          A pointer to the access code.
 java.lang.String getDestinationSource()
          Source of information to specify parameter destination in function TRouteCall. See comments.
 java.lang.String getDnisSource()
          Source of information to specify parameter dnis in function TRouteCall.
 java.lang.String getDnSource()
          Source of information to specify parameter dn in function TRouteCall. See comments.
 java.lang.String getExtensionSource()
          Source of information to specify parameter extensions in function TRouteCall.
 java.lang.String getLocationSource()
          Source of information to specify parameter location in function TRouteCall.
 java.lang.String getReasonSource()
          Source of information to specify parameter reasons in function TRouteCall.
 CfgRouteType getRouteType()
          Type of routing for the target specified in targetType for this switch.
 CfgSwitch getSwitch()
          A unique identifier of the Switch to which this access code is assigned.
 java.lang.Integer getSwitchDBID()
          Retrieves the dbid of the object that is being linked to by the Switch property.
 CfgTargetType getTargetType()
          Type of the target within the switch specified by switchDBID for which all the routing parameters below are specified.
 void setAccessCode(java.lang.String value)
          A pointer to the access code.
 void setDestinationSource(java.lang.String value)
          Source of information to specify parameter destination in function TRouteCall. See comments.
 void setDnisSource(java.lang.String value)
          Source of information to specify parameter dnis in function TRouteCall.
 void setDnSource(java.lang.String value)
          Source of information to specify parameter dn in function TRouteCall. See comments.
 void setExtensionSource(java.lang.String value)
          Source of information to specify parameter extensions in function TRouteCall.
 void setLocationSource(java.lang.String value)
          Source of information to specify parameter location in function TRouteCall.
 void setReasonSource(java.lang.String value)
          Source of information to specify parameter reasons in function TRouteCall.
 void setRouteType(CfgRouteType value)
          Type of routing for the target specified in targetType for this switch.
 void setSwitch(CfgSwitch value)
          A unique identifier of the Switch to which this access code is assigned.
 void setSwitchDBID(int dbid)
          A unique identifier of the Switch to which this access code is assigned.
 void setTargetType(CfgTargetType value)
          Type of the target within the switch specified by switchDBID for which all the routing parameters below are specified.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgStructure
getParent, updateChildrenSavedState
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase
clone, ensureDataBackup, equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, reloadObjectWithNewData, resolveLink, setProperty, toString, toStringProperties, toXml
 
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

CfgSwitchAccessCode

public CfgSwitchAccessCode(IConfService confService,
                           ConfStructure objData,
                           ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol structure data
parent - instance of configuration object as a parent for this structure instance

CfgSwitchAccessCode

public CfgSwitchAccessCode(IConfService confService,
                           org.w3c.dom.Node xmlData,
                           ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing structure data
parent - instance of configuration object as a parent for this structure instance

CfgSwitchAccessCode

public CfgSwitchAccessCode(IConfService confService,
                           ICfgObject parent)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
parent - instance of configuration object as a parent for this structure instance
Method Detail

getSwitch

public final CfgSwitch getSwitch()
A unique identifier of the Switch to which this access code is assigned. Mandatory. If value is set to 0 the accessCode value is used as default access to this switch if no other access code is specified on source switch to access this switch.

Returns:
instance of referred object or null

setSwitch

public final void setSwitch(CfgSwitch value)
A unique identifier of the Switch to which this access code is assigned. Mandatory. If value is set to 0 the accessCode value is used as default access to this switch if no other access code is specified on source switch to access this switch.

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

setSwitchDBID

public final void setSwitchDBID(int dbid)
A unique identifier of the Switch to which this access code is assigned. Mandatory. If value is set to 0 the accessCode value is used as default access to this switch if no other access code is specified on source switch to access this switch.

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

getSwitchDBID

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

Returns:
DBID identifier of referred object or null

getAccessCode

public final java.lang.String getAccessCode()
A pointer to the access code.

Returns:
property value or null

setAccessCode

public final void setAccessCode(java.lang.String value)
A pointer to the access code.

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

getTargetType

public final CfgTargetType getTargetType()
Type of the target within the switch specified by switchDBID for which all the routing parameters below are specified. See CfgTargetType .

Returns:
property value or null

setTargetType

public final void setTargetType(CfgTargetType value)
Type of the target within the switch specified by switchDBID for which all the routing parameters below are specified. See CfgTargetType .

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

getRouteType

public final CfgRouteType getRouteType()
Type of routing for the target specified in targetType for this switch. See CfgRouteType .

Returns:
property value or null

setRouteType

public final void setRouteType(CfgRouteType value)
Type of routing for the target specified in targetType for this switch. See CfgRouteType .

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

getDnSource

public final java.lang.String getDnSource()
Source of information to specify parameter dn in function TRouteCall. See comments.

Returns:
property value or null

setDnSource

public final void setDnSource(java.lang.String value)
Source of information to specify parameter dn in function TRouteCall. See comments.

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

getDestinationSource

public final java.lang.String getDestinationSource()
Source of information to specify parameter destination in function TRouteCall. See comments.

Returns:
property value or null

setDestinationSource

public final void setDestinationSource(java.lang.String value)
Source of information to specify parameter destination in function TRouteCall. See comments.

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

getLocationSource

public final java.lang.String getLocationSource()
Source of information to specify parameter location in function TRouteCall.

Returns:
property value or null

setLocationSource

public final void setLocationSource(java.lang.String value)
Source of information to specify parameter location in function TRouteCall.

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

getDnisSource

public final java.lang.String getDnisSource()
Source of information to specify parameter dnis in function TRouteCall.

Returns:
property value or null

setDnisSource

public final void setDnisSource(java.lang.String value)
Source of information to specify parameter dnis in function TRouteCall.

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

getReasonSource

public final java.lang.String getReasonSource()
Source of information to specify parameter reasons in function TRouteCall.

Returns:
property value or null

setReasonSource

public final void setReasonSource(java.lang.String value)
Source of information to specify parameter reasons in function TRouteCall.

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

getExtensionSource

public final java.lang.String getExtensionSource()
Source of information to specify parameter extensions in function TRouteCall.

Returns:
property value or null

setExtensionSource

public final void setExtensionSource(java.lang.String value)
Source of information to specify parameter extensions in function TRouteCall.

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

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.