|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgBase
com.genesyslab.platform.applicationblocks.com.CfgObject
com.genesyslab.platform.applicationblocks.com.objects.CfgPlace
public class CfgPlace
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:
placeDBIDs
of all place groups
that included Place X
placeDBID
of all persons who
had Place X assigned as the default place
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgPlace(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
confService
- configuration service instanceobjData
- configuration protocol object data structureisSaved
- indicator of the object saved stateadditionalParameters
- additional parameters from configuration protocol messagepublic CfgPlace(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
confService
- configuration service instancexmlData
- XML object containing object dataadditionalParameters
- additional parameters from configuration protocol messagepublic CfgPlace(IConfService confService)
confService
- configuration service instanceMethod Detail |
---|
public void save() throws ConfigException
save
in interface ICfgObject
save
in class CfgObject
ConfigException
- in case of protocol level exception, data transformation,
or server side constraintspublic final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final CfgTenant getTenant()
Tenant
that this place belongs to. Mandatory. Once specified, cannot
be changed.
public final void setTenant(CfgTenant value)
Tenant
that this place belongs to. Mandatory. Once specified, cannot
be changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
Tenant
that this place belongs to. Mandatory. Once specified, cannot
be changed.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final java.util.Collection<CfgDN> getDNs()
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.
public final void setDNs(java.util.Collection<CfgDN> value)
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.
value
- new property valuegetDNs()
public final java.util.Collection<java.lang.Integer> getDNDBIDs()
public final void setDNDBIDs(java.util.Collection<java.lang.Integer> value)
value
- collection of DBID identifiers of referred objectspublic final CfgObjectState getState()
CfgObjectState
public final void setState(CfgObjectState value)
CfgObjectState
value
- new property valuegetState()
public final KeyValueCollection getUserProperties()
public final void setUserProperties(KeyValueCollection value)
value
- new property valuegetUserProperties()
public final CfgScript getCapacityRule()
CfgScript
)
associated with this place.
public final void setCapacityRule(CfgScript value)
CfgScript
)
associated with this place.
value
- new property valuegetCapacityRule()
public final void setCapacityRuleDBID(int dbid)
CfgScript
)
associated with this place.
dbid
- DBID identifier of referred objectgetCapacityRule()
public final java.lang.Integer getCapacityRuleDBID()
public final CfgFolder getSite()
Site
(CfgFolder) with which this Place is associated.
public final void setSite(CfgFolder value)
Site
(CfgFolder) with which this Place is associated.
value
- new property valuegetSite()
public final void setSiteDBID(int dbid)
Site
(CfgFolder) with which this Place is associated.
dbid
- DBID identifier of referred objectgetSite()
public final java.lang.Integer getSiteDBID()
public final CfgObjectiveTable getContract()
Cost Contract
(CfgObjectiveTable) with which this Place is associated.
public final void setContract(CfgObjectiveTable value)
Cost Contract
(CfgObjectiveTable) with which this Place is associated.
value
- new property valuegetContract()
public final void setContractDBID(int dbid)
Cost Contract
(CfgObjectiveTable) with which this Place is associated.
dbid
- DBID identifier of referred objectgetContract()
public final java.lang.Integer getContractDBID()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |