Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDN

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

public class CfgDN
extends CfgObject

A DN is a communication device that is uniquely identified by a directory number, where customer interactions (for example, telephone calls or e-mails) reside and are handled.

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



See also:

CfgDeltaDN

CfgSwitch

CfgDNGroup

CfgPlace


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgDN(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDN(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgDN(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.util.Collection<CfgDNAccessNumber> getAccessNumbers()
          A pointer to the list of structures that specify the numbers to be dialed from different switches to get this DN.
 java.lang.String getAssociation()
          A pointer to the identifier of an entity permanently associated with this DN (e.g., an IVR port number, channel name, or access number).
 CfgObjectiveTable getContract()
          A unique identifier of Cost Contract (CfgObjectiveTable) with which this DN is associated.
 java.lang.Integer getContractDBID()
          Retrieves the dbid of the object that is being linked to by the Contract property.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.util.Collection<java.lang.Integer> getDestDNDBIDs()
          Retrieves dbids of objects that are being linked to by the DestDNs property.
 java.util.Collection<CfgDN> getDestDNs()
          A pointer to the list of identifiers of the objects (DBIDs) to which the calls residing at this DN can be routed/diverted by default.
 java.lang.String getDNLoginID()
          A pointer to the login identifier used to activate this DN.
 CfgDNGroup getGroup()
          A unique identifier of the DN Group used in number translation.
 java.lang.Integer getGroupDBID()
          Retrieves the dbid of the object that is being linked to by the Group property.
 CfgFlag getLoginFlag()
          An indicator of whether a login procedure is necessary to activate the telephony object associated with this DN.
 java.lang.String getName()
          Name of this DN required if the DN is planned to be used as a target in routing strategies.
 java.lang.String getNumber()
          Directory number assigned to this DN within the switch.
 java.lang.String getOverride()
          The number used as a substitute of a regular directory number in certain types of routing.
 CfgDNRegisterFlag getRegisterAll()
          An indicator of whether T-Server shall register this DN within the switch.
 CfgRouteType getRouteType()
          Type of routing that applies to this DN.
 CfgFolder getSite()
          A unique identifier of Site (CfgFolder) with which this DN is associated.
 java.lang.Integer getSiteDBID()
          Retrieves the dbid of the object that is being linked to by the Site property.
 CfgObjectState getState()
          Current object state.
 CfgSwitch getSwitch()
          A unique identifier of the Switch to which this DN belongs.
 java.lang.Integer getSwitchDBID()
          Retrieves the dbid of the object that is being linked to by the Switch property.
 java.lang.Integer getSwitchSpecificType()
          An integer that corresponds to a combination of switch-specific settings for this DN.
 CfgTenant getTenant()
          A unique identifier of the Tenant to which this DN belongs.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 java.lang.Integer getTrunks()
          Number of trunks associated with this DN.
 CfgDNType getType()
          Type of this DN.
 CfgFlag getUseOverride()
          An indicator of whether the override value shall be used instead of the number or name value for accessing this DN in certain types of routing.
 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 setAccessNumbers(java.util.Collection<CfgDNAccessNumber> value)
          A pointer to the list of structures that specify the numbers to be dialed from different switches to get this DN.
 void setAssociation(java.lang.String value)
          A pointer to the identifier of an entity permanently associated with this DN (e.g., an IVR port number, channel name, or access number).
 void setContract(CfgObjectiveTable value)
          A unique identifier of Cost Contract (CfgObjectiveTable) with which this DN is associated.
 void setContractDBID(int dbid)
          A unique identifier of Cost Contract (CfgObjectiveTable) with which this DN is associated.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDestDNDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the DestDNs property.
 void setDestDNs(java.util.Collection<CfgDN> value)
          A pointer to the list of identifiers of the objects (DBIDs) to which the calls residing at this DN can be routed/diverted by default.
 void setDNLoginID(java.lang.String value)
          A pointer to the login identifier used to activate this DN.
 void setGroup(CfgDNGroup value)
          A unique identifier of the DN Group used in number translation.
 void setGroupDBID(int dbid)
          A unique identifier of the DN Group used in number translation.
 void setName(java.lang.String value)
          Name of this DN required if the DN is planned to be used as a target in routing strategies.
 void setNumber(java.lang.String value)
          Directory number assigned to this DN within the switch.
 void setOverride(java.lang.String value)
          The number used as a substitute of a regular directory number in certain types of routing.
 void setRegisterAll(CfgDNRegisterFlag value)
          An indicator of whether T-Server shall register this DN within the switch.
 void setRouteType(CfgRouteType value)
          Type of routing that applies to this DN.
 void setSite(CfgFolder value)
          A unique identifier of Site (CfgFolder) with which this DN is associated.
 void setSiteDBID(int dbid)
          A unique identifier of Site (CfgFolder) with which this DN is associated.
 void setState(CfgObjectState value)
          Current object state.
 void setSwitch(CfgSwitch value)
          A unique identifier of the Switch to which this DN belongs.
 void setSwitchDBID(int dbid)
          A unique identifier of the Switch to which this DN belongs.
 void setSwitchSpecificType(java.lang.Integer value)
          An integer that corresponds to a combination of switch-specific settings for this DN.
 void setTenant(CfgTenant value)
          A unique identifier of the Tenant to which this DN belongs.
 void setTenantDBID(int dbid)
          A unique identifier of the Tenant to which this DN belongs.
 void setTrunks(java.lang.Integer value)
          Number of trunks associated with this DN.
 void setType(CfgDNType value)
          Type of this DN.
 void setUseOverride(CfgFlag value)
          An indicator of whether the override value shall be used instead of the number or name value for accessing this DN in certain types of routing.
 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

CfgDN

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

CfgDN

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

CfgDN

public CfgDN(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()

getSwitch

public final CfgSwitch getSwitch()
A unique identifier of the Switch to which this DN belongs. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

setSwitch

public final void setSwitch(CfgSwitch value)
A unique identifier of the Switch to which this DN belongs. Mandatory. Once specified, cannot be changed.

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

setSwitchDBID

public final void setSwitchDBID(int dbid)
A unique identifier of the Switch to which this DN belongs. Mandatory. Once specified, cannot be changed.

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

getTenant

public final CfgTenant getTenant()
A unique identifier of the Tenant to which this DN belongs. Read-only (set automatically according to the current value of tenantDBID of the switch specified in switchDBID). See CfgSwitch .

Returns:
instance of referred object or null

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the Tenant to which this DN belongs. Read-only (set automatically according to the current value of tenantDBID of the switch specified in switchDBID). See CfgSwitch .

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

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the Tenant to which this DN belongs. Read-only (set automatically according to the current value of tenantDBID of the switch specified in switchDBID). See CfgSwitch .

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

getType

public final CfgDNType getType()
Type of this DN. See CfgDNType . Mandatory. Once specified, cannot be changed.

Returns:
property value or null

setType

public final void setType(CfgDNType value)
Type of this DN. See CfgDNType . Mandatory. Once specified, cannot be changed.

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

getNumber

public final java.lang.String getNumber()
Directory number assigned to this DN within the switch. Mandatory. Must be unique within the switch for all dn types except CFGDestinationLabel and CFGAccessResource. The uniqueness of CFGAccessResource is defined by combination of number and DN type. Once specified, cannot be changed. Please see the comment regarding the parameter DNRange in CfgSwitch .

Returns:
property value or null

setNumber

public final void setNumber(java.lang.String value)
Directory number assigned to this DN within the switch. Mandatory. Must be unique within the switch for all dn types except CFGDestinationLabel and CFGAccessResource. The uniqueness of CFGAccessResource is defined by combination of number and DN type. Once specified, cannot be changed. Please see the comment regarding the parameter DNRange in CfgSwitch .

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

getAssociation

public final java.lang.String getAssociation()
A pointer to the identifier of an entity permanently associated with this DN (e.g., an IVR port number, channel name, or access number).

Returns:
property value or null

setAssociation

public final void setAssociation(java.lang.String value)
A pointer to the identifier of an entity permanently associated with this DN (e.g., an IVR port number, channel name, or access number).

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

getDestDNs

public final java.util.Collection<CfgDN> getDestDNs()
A pointer to the list of identifiers of the objects (DBIDs) to which the calls residing at this DN can be routed/diverted by default. Makes sense only if type is set to CFGRoutingPoint, CFGExtRoutingPoint, CFGServiceNumber, CFGRoutingQueue, CFGACDQueue, CFGVirtACDQueue, or CFGVirtRoutingPoint, and CFGAccessResource and shall be set to NULL for all other values of type. When used as an entry in CfgDeltaDN (see below), it is a pointer to a list of identifiers of the objects added to the existing list. The DN for which this list is specified cannot be added to this list. If DN type is CFGAccessResource the property must be presented on GUI (Config Manager) with caption _Remote Resources_.

Returns:
list of configuration objects or null

setDestDNs

public final void setDestDNs(java.util.Collection<CfgDN> value)
A pointer to the list of identifiers of the objects (DBIDs) to which the calls residing at this DN can be routed/diverted by default. Makes sense only if type is set to CFGRoutingPoint, CFGExtRoutingPoint, CFGServiceNumber, CFGRoutingQueue, CFGACDQueue, CFGVirtACDQueue, or CFGVirtRoutingPoint, and CFGAccessResource and shall be set to NULL for all other values of type. When used as an entry in CfgDeltaDN (see below), it is a pointer to a list of identifiers of the objects added to the existing list. The DN for which this list is specified cannot be added to this list. If DN type is CFGAccessResource the property must be presented on GUI (Config Manager) with caption _Remote Resources_.

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

getDestDNDBIDs

public final java.util.Collection<java.lang.Integer> getDestDNDBIDs()
Retrieves dbids of objects that are being linked to by the DestDNs property. It's a snapshot collection containing original values. Modification of this collection instance will not affect actual value of the objects' property.

Returns:
collection of DBID identifiers of referred objects or null

setDestDNDBIDs

public final void setDestDNDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the DestDNs property.

Parameters:
value - collection of DBID identifiers of referred objects

getLoginFlag

public final CfgFlag getLoginFlag()
An indicator of whether a login procedure is necessary to activate the telephony object associated with this DN. Read-only (set automatically according to the current value of DNLoginID below). See CfgFlag. The value should not be taken into consideration if DN type is CFGAccessResource.

Returns:
property value or null

getDNLoginID

public final java.lang.String getDNLoginID()
A pointer to the login identifier used to activate this DN. Makes sense only if type is set to CFGACDPosition, CFGExtension, CFGEAPort, CFGVoiceMail, or CFGMixed. For type CFGAccessResource specifies the type of the resource and must be presented on GIU(Configuration Manager) with caption _Resource Type_

Returns:
property value or null

setDNLoginID

public final void setDNLoginID(java.lang.String value)
A pointer to the login identifier used to activate this DN. Makes sense only if type is set to CFGACDPosition, CFGExtension, CFGEAPort, CFGVoiceMail, or CFGMixed. For type CFGAccessResource specifies the type of the resource and must be presented on GIU(Configuration Manager) with caption _Resource Type_

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

getRegisterAll

public final CfgDNRegisterFlag getRegisterAll()
An indicator of whether T-Server shall register this DN within the switch. Recommended to be set to CFGDRTrue by default. See CfgDNRegisterFlag .

Returns:
property value or null

setRegisterAll

public final void setRegisterAll(CfgDNRegisterFlag value)
An indicator of whether T-Server shall register this DN within the switch. Recommended to be set to CFGDRTrue by default. See CfgDNRegisterFlag .

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

getGroup

public final CfgDNGroup getGroup()
A unique identifier of the DN Group used in number translation.

Returns:
instance of referred object or null

setGroup

public final void setGroup(CfgDNGroup value)
A unique identifier of the DN Group used in number translation.

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

setGroupDBID

public final void setGroupDBID(int dbid)
A unique identifier of the DN Group used in number translation.

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

getGroupDBID

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

Returns:
DBID identifier of referred object or null

getTrunks

public final java.lang.Integer getTrunks()
Number of trunks associated with this DN. Makes sense only if type is set to CFGDestinationLabel.

Returns:
property value or null

setTrunks

public final void setTrunks(java.lang.Integer value)
Number of trunks associated with this DN. Makes sense only if type is set to CFGDestinationLabel.

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

getRouteType

public final CfgRouteType getRouteType()
Type of routing that applies to this DN. See type CfgRouteType .

Returns:
property value or null

setRouteType

public final void setRouteType(CfgRouteType value)
Type of routing that applies to this DN. See type CfgRouteType .

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

getOverride

public final java.lang.String getOverride()
The number used as a substitute of a regular directory number in certain types of routing.

Returns:
property value or null

setOverride

public final void setOverride(java.lang.String value)
The number used as a substitute of a regular directory number in certain types of routing.

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

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()

getName

public final java.lang.String getName()
Name of this DN required if the DN is planned to be used as a target in routing strategies. If specified, must be unique within the tenant this DN belongs to. It is strongly recommended to give names to DNs of the following types: CFGACDQueue, CFGRoutingPoint, CFGVirtualACDQueue, CFGVirtualRoutingPoint, and CFGRoutingQueue.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
Name of this DN required if the DN is planned to be used as a target in routing strategies. If specified, must be unique within the tenant this DN belongs to. It is strongly recommended to give names to DNs of the following types: CFGACDQueue, CFGRoutingPoint, CFGVirtualACDQueue, CFGVirtualRoutingPoint, and CFGRoutingQueue.

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

getUseOverride

public final CfgFlag getUseOverride()
An indicator of whether the override value shall be used instead of the number or name value for accessing this DN in certain types of routing. Recommended to be set to CFGTrue by default. See CfgFlag .

Returns:
property value or null

setUseOverride

public final void setUseOverride(CfgFlag value)
An indicator of whether the override value shall be used instead of the number or name value for accessing this DN in certain types of routing. Recommended to be set to CFGTrue by default. See CfgFlag .

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

getSwitchSpecificType

public final java.lang.Integer getSwitchSpecificType()
An integer that corresponds to a combination of switch-specific settings for this DN. Cannot be set to a zero or negative value.

Returns:
property value or null

setSwitchSpecificType

public final void setSwitchSpecificType(java.lang.Integer value)
An integer that corresponds to a combination of switch-specific settings for this DN. Cannot be set to a zero or negative value.

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

getAccessNumbers

public final java.util.Collection<CfgDNAccessNumber> getAccessNumbers()
A pointer to the list of structures that specify the numbers to be dialed from different switches to get this DN. Makes sense only if type is set to CFGExtRoutingPoint and CFGAccessResource. See CfgDNAccessNumber .

Returns:
list of structures or null

setAccessNumbers

public final void setAccessNumbers(java.util.Collection<CfgDNAccessNumber> value)
A pointer to the list of structures that specify the numbers to be dialed from different switches to get this DN. Makes sense only if type is set to CFGExtRoutingPoint and CFGAccessResource. See CfgDNAccessNumber .

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

getSite

public final CfgFolder getSite()
A unique identifier of Site (CfgFolder) with which this DN is associated.

Returns:
instance of referred object or null

setSite

public final void setSite(CfgFolder value)
A unique identifier of Site (CfgFolder) with which this DN is associated.

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

setSiteDBID

public final void setSiteDBID(int dbid)
A unique identifier of Site (CfgFolder) with which this DN is associated.

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

getSiteDBID

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

Returns:
DBID identifier of referred object or null

getContract

public final CfgObjectiveTable getContract()
A unique identifier of Cost Contract (CfgObjectiveTable) with which this DN is associated.

Returns:
instance of referred object or null

setContract

public final void setContract(CfgObjectiveTable value)
A unique identifier of Cost Contract (CfgObjectiveTable) with which this DN is associated.

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

setContractDBID

public final void setContractDBID(int dbid)
A unique identifier of Cost Contract (CfgObjectiveTable) with which this DN is associated.

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

getContractDBID

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

Returns:
DBID identifier of referred object 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.