Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaDN

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

public class CfgDeltaDN
extends CfgDelta

The changes to make to a CfgDN object.


Constructor Summary
CfgDeltaDN(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaDN(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaDN(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<CfgDNAccessNumber> getAddedAccessNumbers()
          A pointer to the list of structures that specify the numbers to be dialed from different switches to get this DN.
 java.util.Collection<java.lang.Integer> getAddedDestDNDBIDs()
          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.util.Collection<CfgDN> getAddedDestDNs()
          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.
 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.
 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).
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 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()
          The DBID of the target CfgDN configuration object.
 java.util.Collection<CfgDNAccessNumber> getDeletedAccessNumbers()
          A pointer to the list of deleted access numbers ( every item of this list is structured as CfgDNAccessNumber )
 java.util.Collection<java.lang.Integer> getDeletedDestDNDBIDs()
          A pointer to the list of identifiers of the objects to which the calls residing at this DN can no longer be routed by default.
 java.util.Collection<CfgDN> getDeletedDestDNs()
          A pointer to the list of identifiers of the objects to which the calls residing at this DN can no longer be routed by default.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 java.util.Collection<java.lang.Integer> getDestDNDBIDs()
          Deprecated.  
 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.
 CfgDN retrieveCfgDN()
          Read base CfgDN 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

CfgDeltaDN

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

Parameters:
confService - configuration service instance

CfgDeltaDN

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

CfgDeltaDN

public CfgDeltaDN(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 CfgDN configuration object.

Returns:
target object DBID

retrieveCfgDN

public final CfgDN retrieveCfgDN()
                          throws ConfigException
Read base CfgDN configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

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

getSwitchDBID

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

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

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

getType

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

Returns:
property value or null

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

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

getAddedDestDNs

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

getAddedDestDNDBIDs

public final java.util.Collection<java.lang.Integer> getAddedDestDNDBIDs()
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:
collection of DBID identifiers of referred objects or null

getDestDNDBIDs

@Deprecated
public final java.util.Collection<java.lang.Integer> getDestDNDBIDs()
Deprecated. 

See Also:
getAddedDestDNDBIDs()

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

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

getGroup

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

Returns:
instance of referred object or null

getGroupDBID

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

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

getRouteType

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

Returns:
property value or null

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

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

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

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

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

getAddedAccessNumbers

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

getSite

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

Returns:
instance of referred object or null

getSiteDBID

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

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

getContractDBID

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

Returns:
DBID identifier of referred object or null

getDeletedDestDNs

public final java.util.Collection<CfgDN> getDeletedDestDNs()
A pointer to the list of identifiers of the objects to which the calls residing at this DN can no longer be routed by default.

Returns:
list of configuration objects or null

getDeletedDestDNDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedDestDNDBIDs()
A pointer to the list of identifiers of the objects to which the calls residing at this DN can no longer be routed by default.

Returns:
collection of DBID identifiers of referred objects 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

getDeletedAccessNumbers

public final java.util.Collection<CfgDNAccessNumber> getDeletedAccessNumbers()
A pointer to the list of deleted access numbers ( every item of this list is structured as CfgDNAccessNumber )

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