Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDNGroup

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

public class CfgDNGroup
extends CfgObject

You can set up Groups of DNs for use in network-level routing algorithms and in some types of statistics. Consult solution-specific documentation to see if you need to set up DN Groups.

When you are specifying a DN Group, remember that the DNs comprising this group must have the same telephony event model.

The name of a DN group must be unique within the tenant, but can coincide with the names of access groups, place groups and agent groups of the same tenant.

The name of a DN group cannot be changed until there is at least one DN listed in this group. See DNs property

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



See also:

CfgDeltaDNGroup

CfgDN


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgDNGroup(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDNGroup(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgDNGroup(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.util.Collection<CfgDNInfo> getDNs()
          A pointer to the list of the DNs that form this group (every item of this list is structured as CfgDNInfo ).
 CfgGroup getGroupInfo()
          A pointer to the structure CfgGroup containing general information about this group.
 CfgDNGroupType getType()
          Type of this DN group.
 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 setDNs(java.util.Collection<CfgDNInfo> value)
          A pointer to the list of the DNs that form this group (every item of this list is structured as CfgDNInfo ).
 void setGroupInfo(CfgGroup value)
          A pointer to the structure CfgGroup containing general information about this group.
 void setType(CfgDNGroupType value)
          Type of this DN group.
 
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

CfgDNGroup

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

CfgDNGroup

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

CfgDNGroup

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

getGroupInfo

public final CfgGroup getGroupInfo()
A pointer to the structure CfgGroup containing general information about this group. Mandatory.

Returns:
property value or null

setGroupInfo

public final void setGroupInfo(CfgGroup value)
A pointer to the structure CfgGroup containing general information about this group. Mandatory.

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

getType

public final CfgDNGroupType getType()
Type of this DN group. Once specified, cannot be changed. Refer to CfgDNGroupType .

Returns:
property value or null

setType

public final void setType(CfgDNGroupType value)
Type of this DN group. Once specified, cannot be changed. Refer to CfgDNGroupType .

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

getDNs

public final java.util.Collection<CfgDNInfo> getDNs()
A pointer to the list of the DNs that form this group (every item of this list is structured as CfgDNInfo ).

Returns:
list of structures or null

setDNs

public final void setDNs(java.util.Collection<CfgDNInfo> value)
A pointer to the list of the DNs that form this group (every item of this list is structured as CfgDNInfo ).

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

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.