|
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.CfgStructure
com.genesyslab.platform.applicationblocks.com.objects.CfgGroup
public class CfgGroup
A group. For special requirements that apply to the entities of
CfgGroup
when it is used as part of an access group,
see the description of parameter
groupInfo
of type CfgAccessGroup
in
section Access Control Functions and Data Types
.
Constructor Summary | |
---|---|
CfgGroup(IConfService confService,
ConfStructure objData,
ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. |
|
CfgGroup(IConfService confService,
ICfgObject parent)
This constructor is intended for creation of detached objects. |
|
CfgGroup(IConfService confService,
org.w3c.dom.Node xmlData,
ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. |
Method Summary | |
---|---|
CfgScript |
getCapacityRule()
A unique identifier of the capacity rule (
Script
) associated
with this group. |
java.lang.Integer |
getCapacityRuleDBID()
Retrieves the dbid of the object that is being linked to by the CapacityRule property. |
CfgStatTable |
getCapacityTable()
A unique identifier of the
Stat Table
of CFGCapacityTable type
associated with this group. |
java.lang.Integer |
getCapacityTableDBID()
Retrieves the dbid of the object that is being linked to by the CapacityTable property. |
CfgObjectiveTable |
getContract()
A unique identifier of Cost Contract (
Objective Table
) with which this Group 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> |
getManagerDBIDs()
Retrieves dbids of objects that are being linked to by the Managers property. |
java.util.Collection<CfgPerson> |
getManagers()
A pointer to the list of the identifiers of the
CfgPerson
objects that serve as supervisors
of this group. |
java.lang.String |
getName()
A pointer to name of the group. |
CfgStatTable |
getQuotaTable()
A unique identifier of the
Stat Table
of CFGQuotaTable type
associated with this group. |
java.lang.Integer |
getQuotaTableDBID()
Retrieves the dbid of the object that is being linked to by the QuotaTable property. |
java.util.Collection<java.lang.Integer> |
getRouteDNDBIDs()
Retrieves dbids of objects that are being linked to by the RouteDNs property. |
java.util.Collection<CfgDN> |
getRouteDNs()
A pointer to the list of identifiers of the telephony objects from which calls can be routed/diverted to this group. |
CfgFolder |
getSite()
A unique identifier of Site (
Folder
) with which this Group 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 group 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 |
setCapacityRule(CfgScript value)
A unique identifier of the capacity rule (
Script
) associated
with this group. |
void |
setCapacityRuleDBID(int dbid)
A unique identifier of the capacity rule (
Script
) associated
with this group. |
void |
setCapacityTable(CfgStatTable value)
A unique identifier of the
Stat Table
of CFGCapacityTable type
associated with this group. |
void |
setCapacityTableDBID(int dbid)
A unique identifier of the
Stat Table
of CFGCapacityTable type
associated with this group. |
void |
setContract(CfgObjectiveTable value)
A unique identifier of Cost Contract (
Objective Table
) with which this Group is associated. |
void |
setContractDBID(int dbid)
A unique identifier of Cost Contract (
Objective Table
) with which this Group is associated. |
void |
setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. |
void |
setManagerDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the Managers property. |
void |
setManagers(java.util.Collection<CfgPerson> value)
A pointer to the list of the identifiers of the
CfgPerson
objects that serve as supervisors
of this group. |
void |
setName(java.lang.String value)
A pointer to name of the group. |
void |
setQuotaTable(CfgStatTable value)
A unique identifier of the
Stat Table
of CFGQuotaTable type
associated with this group. |
void |
setQuotaTableDBID(int dbid)
A unique identifier of the
Stat Table
of CFGQuotaTable type
associated with this group. |
void |
setRouteDNDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the RouteDNs property. |
void |
setRouteDNs(java.util.Collection<CfgDN> value)
A pointer to the list of identifiers of the telephony objects from which calls can be routed/diverted to this group. |
void |
setSite(CfgFolder value)
A unique identifier of Site (
Folder
) with which this Group is associated. |
void |
setSiteDBID(int dbid)
A unique identifier of Site (
Folder
) with which this Group is associated. |
void |
setState(CfgObjectState value)
Current object state. |
void |
setTenant(CfgTenant value)
A unique identifier of the
Tenant
that this group belongs to. |
void |
setTenantDBID(int dbid)
A unique identifier of the
Tenant
that this group 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.CfgStructure |
---|
getParent, updateChildrenSavedState |
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase |
---|
clone, ensureDataBackup, equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, reloadObjectWithNewData, resolveLink, setProperty, toString, toStringProperties, toXml |
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 |
---|
public CfgGroup(IConfService confService, ConfStructure objData, ICfgObject parent)
confService
- configuration service instanceobjData
- configuration protocol structure dataparent
- instance of configuration object as a parent for this structure instancepublic CfgGroup(IConfService confService, org.w3c.dom.Node xmlData, ICfgObject parent)
confService
- configuration service instancexmlData
- XML object containing structure dataparent
- instance of configuration object as a parent for this structure instancepublic CfgGroup(IConfService confService, ICfgObject parent)
confService
- configuration service instanceparent
- instance of configuration object as a parent for this structure instanceMethod Detail |
---|
public final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final CfgTenant getTenant()
Tenant
that this group belongs to. Mandatory. Once specified, cannot be
changed.
public final void setTenant(CfgTenant value)
Tenant
that this group belongs to. Mandatory. Once specified, cannot be
changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
Tenant
that this group 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()
CfgAgentGroup
,
CfgPlaceGroup, and
CfgDNGroup
.
public final void setName(java.lang.String value)
CfgAgentGroup
,
CfgPlaceGroup, and
CfgDNGroup
.
value
- new property valuegetName()
public final java.util.Collection<CfgPerson> getManagers()
CfgPerson
objects that serve as supervisors
of this group. Applicable for CfgAgentGroup only. When used as an
entry in CfgDeltaGroup
, it is a pointer to a list of identifiers
of the Persons added to the existing list. A person assigned as a supervisor to
this Group should belong either to the same Tenant as the Group or to
the Tenant Environment
.
public final void setManagers(java.util.Collection<CfgPerson> value)
CfgPerson
objects that serve as supervisors
of this group. Applicable for CfgAgentGroup only. When used as an
entry in CfgDeltaGroup
, it is a pointer to a list of identifiers
of the Persons added to the existing list. A person assigned as a supervisor to
this Group should belong either to the same Tenant as the Group or to
the Tenant Environment
.
value
- new property valuegetManagers()
public final java.util.Collection<java.lang.Integer> getManagerDBIDs()
public final void setManagerDBIDs(java.util.Collection<java.lang.Integer> value)
value
- collection of DBID identifiers of referred objectspublic final java.util.Collection<CfgDN> getRouteDNs()
CFGExtRoutingPoint,
CFGServiceNumber,
CFGRoutingQueue,
CFGRoutingPoint
or
CFGACDQueue,
CFGVirtACDQueue
and
CFGVirtRoutingPoint
. When used as an entry in CfgDeltaGroup
,
it is a pointer to a list of identifiers of the DNs added to the existing list.
public final void setRouteDNs(java.util.Collection<CfgDN> value)
CFGExtRoutingPoint,
CFGServiceNumber,
CFGRoutingQueue,
CFGRoutingPoint
or
CFGACDQueue,
CFGVirtACDQueue
and
CFGVirtRoutingPoint
. When used as an entry in CfgDeltaGroup
,
it is a pointer to a list of identifiers of the DNs added to the existing list.
value
- new property valuegetRouteDNs()
public final java.util.Collection<java.lang.Integer> getRouteDNDBIDs()
public final void setRouteDNDBIDs(java.util.Collection<java.lang.Integer> value)
value
- collection of DBID identifiers of referred objectspublic final CfgStatTable getCapacityTable()
Stat Table
of CFGCapacityTable
type
associated with this group.
public final void setCapacityTable(CfgStatTable value)
Stat Table
of CFGCapacityTable
type
associated with this group.
value
- new property valuegetCapacityTable()
public final void setCapacityTableDBID(int dbid)
Stat Table
of CFGCapacityTable
type
associated with this group.
dbid
- DBID identifier of referred objectgetCapacityTable()
public final java.lang.Integer getCapacityTableDBID()
public final CfgStatTable getQuotaTable()
Stat Table
of CFGQuotaTable
type
associated with this group.
public final void setQuotaTable(CfgStatTable value)
Stat Table
of CFGQuotaTable
type
associated with this group.
value
- new property valuegetQuotaTable()
public final void setQuotaTableDBID(int dbid)
Stat Table
of CFGQuotaTable
type
associated with this group.
dbid
- DBID identifier of referred objectgetQuotaTable()
public final java.lang.Integer getQuotaTableDBID()
public 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()
Script
) associated
with this group. Applicable for CfgPlaceGroup and CfgAgentGroup
only.
public final void setCapacityRule(CfgScript value)
Script
) associated
with this group. Applicable for CfgPlaceGroup and CfgAgentGroup
only.
value
- new property valuegetCapacityRule()
public final void setCapacityRuleDBID(int dbid)
Script
) associated
with this group. Applicable for CfgPlaceGroup and CfgAgentGroup
only.
dbid
- DBID identifier of referred objectgetCapacityRule()
public final java.lang.Integer getCapacityRuleDBID()
public final CfgFolder getSite()
Folder
) with which this Group is associated.
public final void setSite(CfgFolder value)
Folder
) with which this Group is associated.
value
- new property valuegetSite()
public final void setSiteDBID(int dbid)
Folder
) with which this Group is associated.
dbid
- DBID identifier of referred objectgetSite()
public final java.lang.Integer getSiteDBID()
public final CfgObjectiveTable getContract()
Objective Table
) with which this Group is associated.
public final void setContract(CfgObjectiveTable value)
Objective Table
) with which this Group is associated.
value
- new property valuegetContract()
public final void setContractDBID(int dbid)
Objective Table
) with which this Group 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 |