Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgAgentGroup

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

public class CfgAgentGroup
extends CfgObject

Groups of Agents are typically set up to provide particular sets of contact center services.

The name of an agent group must be unique within the tenant, but can coincide with the name of either a place group or a DN group of the same tenant.

The name of an agent group cannot be changed until there is at least one agent listed in this group. See agentDBIDs property

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



See also:

CfgDeltaAgentGroup

CfgPerson


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgAgentGroup(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgAgentGroup(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgAgentGroup(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<java.lang.Integer> getAgentDBIDs()
          Retrieves dbids of objects that are being linked to by the Agents property.
 java.util.Collection<CfgPerson> getAgents()
          A pointer to the list of identifiers of the Agents that form this group.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 CfgGroup getGroupInfo()
          A pointer to the structure CfgGroup containing general information about this group.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setAgentDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the Agents property.
 void setAgents(java.util.Collection<CfgPerson> value)
          A pointer to the list of identifiers of the Agents that form this group.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setGroupInfo(CfgGroup value)
          A pointer to the structure CfgGroup containing general information about this 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

CfgAgentGroup

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

CfgAgentGroup

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

CfgAgentGroup

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

getAgents

public final java.util.Collection<CfgPerson> getAgents()
A pointer to the list of identifiers of the Agents that form this group.

Returns:
list of configuration objects or null

setAgents

public final void setAgents(java.util.Collection<CfgPerson> value)
A pointer to the list of identifiers of the Agents that form this group.

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

getAgentDBIDs

public final java.util.Collection<java.lang.Integer> getAgentDBIDs()
Retrieves dbids of objects that are being linked to by the Agents 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

setAgentDBIDs

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

Parameters:
value - collection of DBID identifiers of referred objects

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.