Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgPlace

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

public class CfgPlace
extends CfgObject

A Place is a location that has one or more DNs operated by a single agent.

Configure Places and assign individual DNs to them in order to monitor performance and availability of Agents, Agent Groups, and Place Groups, and to provide this information to call-processing applications.

A typical Agent Place consists of two DNs: one DN that an agent uses to take customer calls and another DN the agent uses to make consultation calls and transfers. If you are using the multimedia options of the Genesys products, Places may have to be equipped with DNs of other types, such as E-mail Address.

Make sure the configuration of Places in the Configuration Database always matches the actual wiring arrangements in the contact center.

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



See also:

CfgDeltaPlace

CfgDN

CfgPlaceGroup


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgPlace(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgPlace(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgPlace(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
 CfgScript getCapacityRule()
          A unique identifier of the capacity rule ( CfgScript ) associated with this place.
 java.lang.Integer getCapacityRuleDBID()
          Retrieves the dbid of the object that is being linked to by the CapacityRule property.
 CfgObjectiveTable getContract()
          A unique identifier of Cost Contract (CfgObjectiveTable) with which this Place 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> getDNDBIDs()
          Retrieves dbids of objects that are being linked to by the DNs property.
 java.util.Collection<CfgDN> getDNs()
          A pointer to the list of identifiers of the telephony objects that are assigned to this place.
 java.lang.String getName()
          A pointer to the name of the place.
 CfgFolder getSite()
          A unique identifier of Site (CfgFolder) with which this Place 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.
 CfgTenant getTenant()
          A unique identifier of the Tenant that this place belongs to.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 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 setCapacityRule(CfgScript value)
          A unique identifier of the capacity rule ( CfgScript ) associated with this place.
 void setCapacityRuleDBID(int dbid)
          A unique identifier of the capacity rule ( CfgScript ) associated with this place.
 void setContract(CfgObjectiveTable value)
          A unique identifier of Cost Contract (CfgObjectiveTable) with which this Place is associated.
 void setContractDBID(int dbid)
          A unique identifier of Cost Contract (CfgObjectiveTable) with which this Place is associated.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDNDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the DNs property.
 void setDNs(java.util.Collection<CfgDN> value)
          A pointer to the list of identifiers of the telephony objects that are assigned to this place.
 void setName(java.lang.String value)
          A pointer to the name of the place.
 void setSite(CfgFolder value)
          A unique identifier of Site (CfgFolder) with which this Place is associated.
 void setSiteDBID(int dbid)
          A unique identifier of Site (CfgFolder) with which this Place is associated.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the Tenant that this place belongs to.
 void setTenantDBID(int dbid)
          A unique identifier of the Tenant that this place belongs to.
 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

CfgPlace

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

CfgPlace

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

CfgPlace

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

getTenant

public final CfgTenant getTenant()
A unique identifier of the Tenant that this place belongs to. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the Tenant that this place belongs to. Mandatory. Once specified, cannot be changed.

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

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the Tenant that this place belongs to. Mandatory. Once specified, cannot be changed.

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

getName

public final java.lang.String getName()
A pointer to the name of the place. Mandatory. Must be unique within the tenant.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the name of the place. Mandatory. Must be unique within the tenant.

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

getDNs

public final java.util.Collection<CfgDN> getDNs()
A pointer to the list of identifiers of the telephony objects that are assigned to this place. When used as an entry in CfgDeltaPlace (see below), it is a pointer to a list of identifiers of the objects added to the existing list. DNs assigned to the place must belong to the tenant specified by tenantDBID above. One DN cannot be assigned to more than one place. DNs of the following types cannot be included into a place: CFGACDQueue, CFGRoutingPoint, CFGVirtACDQueue, CFGVirtRoutingPoint, CFGTrunk, CFGTrunkGroup, CFGTieLine, CFGTieLineGroup, CFGExtRoutingPoint and CFGRoutingQueue. CFGDestinationLabel, CFGServiceNumber,CFGAccessResource.

Returns:
list of configuration objects or null

setDNs

public final void setDNs(java.util.Collection<CfgDN> value)
A pointer to the list of identifiers of the telephony objects that are assigned to this place. When used as an entry in CfgDeltaPlace (see below), it is a pointer to a list of identifiers of the objects added to the existing list. DNs assigned to the place must belong to the tenant specified by tenantDBID above. One DN cannot be assigned to more than one place. DNs of the following types cannot be included into a place: CFGACDQueue, CFGRoutingPoint, CFGVirtACDQueue, CFGVirtRoutingPoint, CFGTrunk, CFGTrunkGroup, CFGTieLine, CFGTieLineGroup, CFGExtRoutingPoint and CFGRoutingQueue. CFGDestinationLabel, CFGServiceNumber,CFGAccessResource.

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

getDNDBIDs

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

setDNDBIDs

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

Parameters:
value - collection of DBID identifiers of referred objects

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

getCapacityRule

public final CfgScript getCapacityRule()
A unique identifier of the capacity rule ( CfgScript ) associated with this place.

Returns:
instance of referred object or null

setCapacityRule

public final void setCapacityRule(CfgScript value)
A unique identifier of the capacity rule ( CfgScript ) associated with this place.

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

setCapacityRuleDBID

public final void setCapacityRuleDBID(int dbid)
A unique identifier of the capacity rule ( CfgScript ) associated with this place.

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

getCapacityRuleDBID

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

Returns:
DBID identifier of referred object or null

getSite

public final CfgFolder getSite()
A unique identifier of Site (CfgFolder) with which this Place 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 Place 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 Place 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 Place 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 Place 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 Place 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.