|
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.CfgDN
public class CfgDN
A DN is a communication device that is uniquely identified by a directory number, where customer interactions (for example, telephone calls or e-mails) reside and are handled. Deletion of DN X will cause the following events set out in the order of arrival:
DNDBIDs
of the place that had
DN X assigned
destDNDBIDs
of all DNs whose
destination DNs included DN X
routeDNDBIDs
of all agent groups
whose route DNs included DN X
routeDNDBIDs
of all place groups
whose route DNs included DN X
DNs
of all DN groups whose DNs
included DN X
routeDNDBIDs
of all DN groups
whose route DNs included DN X
CfgTreatment
objects which had
destDNDBID
field set to DN X
CfgIVRPort
objects which had DNDBID
field
set to DN X
CfgCampaignGroup
which had origDNDBID
field set to DN X
Field Summary | |
---|---|
static CfgObjectType |
OBJECT_TYPE
|
Constructor Summary | |
---|---|
CfgDN(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgDN(IConfService confService,
ConfObject objData,
boolean isSaved,
java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. |
|
CfgDN(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<CfgDNAccessNumber> |
getAccessNumbers()
A pointer to the list of structures that specify the numbers to be dialed from different switches to get this DN. |
java.lang.String |
getAssociation()
A pointer to the identifier of an entity permanently associated with this DN (e.g., an IVR port number, channel name, or access number). |
CfgObjectiveTable |
getContract()
A unique identifier of
Cost Contract
(CfgObjectiveTable) with which this DN 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> |
getDestDNDBIDs()
Retrieves dbids of objects that are being linked to by the DestDNs property. |
java.util.Collection<CfgDN> |
getDestDNs()
A pointer to the list of identifiers of the objects (DBIDs) to which the calls residing at this DN can be routed/diverted by default. |
java.lang.String |
getDNLoginID()
A pointer to the login identifier used to activate this DN. |
CfgDNGroup |
getGroup()
A unique identifier of the
DN Group
used in number translation. |
java.lang.Integer |
getGroupDBID()
Retrieves the dbid of the object that is being linked to by the Group property. |
CfgFlag |
getLoginFlag()
An indicator of whether a login procedure is necessary to activate the telephony object associated with this DN. |
java.lang.String |
getName()
Name of this DN required if the DN is planned to be used as a target in routing strategies. |
java.lang.String |
getNumber()
Directory number assigned to this DN within the switch. |
java.lang.String |
getOverride()
The number used as a substitute of a regular directory number in certain types of routing. |
CfgDNRegisterFlag |
getRegisterAll()
An indicator of whether T-Server shall register this DN within the switch. |
CfgRouteType |
getRouteType()
Type of routing that applies to this DN. |
CfgFolder |
getSite()
A unique identifier of
Site
(CfgFolder) with which this DN 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. |
CfgSwitch |
getSwitch()
A unique identifier of the
Switch
to which this DN belongs. |
java.lang.Integer |
getSwitchDBID()
Retrieves the dbid of the object that is being linked to by the Switch property. |
java.lang.Integer |
getSwitchSpecificType()
An integer that corresponds to a combination of switch-specific settings for this DN. |
CfgTenant |
getTenant()
A unique identifier of the
Tenant
to which this DN belongs. |
java.lang.Integer |
getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. |
java.lang.Integer |
getTrunks()
Number of trunks associated with this DN. |
CfgDNType |
getType()
Type of this DN. |
CfgFlag |
getUseOverride()
An indicator of whether the override value shall be used instead of
the number or name value for accessing this
DN in certain types of routing. |
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 |
setAccessNumbers(java.util.Collection<CfgDNAccessNumber> value)
A pointer to the list of structures that specify the numbers to be dialed from different switches to get this DN. |
void |
setAssociation(java.lang.String value)
A pointer to the identifier of an entity permanently associated with this DN (e.g., an IVR port number, channel name, or access number). |
void |
setContract(CfgObjectiveTable value)
A unique identifier of
Cost Contract
(CfgObjectiveTable) with which this DN is associated. |
void |
setContractDBID(int dbid)
A unique identifier of
Cost Contract
(CfgObjectiveTable) with which this DN is associated. |
void |
setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. |
void |
setDestDNDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the DestDNs property. |
void |
setDestDNs(java.util.Collection<CfgDN> value)
A pointer to the list of identifiers of the objects (DBIDs) to which the calls residing at this DN can be routed/diverted by default. |
void |
setDNLoginID(java.lang.String value)
A pointer to the login identifier used to activate this DN. |
void |
setGroup(CfgDNGroup value)
A unique identifier of the
DN Group
used in number translation. |
void |
setGroupDBID(int dbid)
A unique identifier of the
DN Group
used in number translation. |
void |
setName(java.lang.String value)
Name of this DN required if the DN is planned to be used as a target in routing strategies. |
void |
setNumber(java.lang.String value)
Directory number assigned to this DN within the switch. |
void |
setOverride(java.lang.String value)
The number used as a substitute of a regular directory number in certain types of routing. |
void |
setRegisterAll(CfgDNRegisterFlag value)
An indicator of whether T-Server shall register this DN within the switch. |
void |
setRouteType(CfgRouteType value)
Type of routing that applies to this DN. |
void |
setSite(CfgFolder value)
A unique identifier of
Site
(CfgFolder) with which this DN is associated. |
void |
setSiteDBID(int dbid)
A unique identifier of
Site
(CfgFolder) with which this DN is associated. |
void |
setState(CfgObjectState value)
Current object state. |
void |
setSwitch(CfgSwitch value)
A unique identifier of the
Switch
to which this DN belongs. |
void |
setSwitchDBID(int dbid)
A unique identifier of the
Switch
to which this DN belongs. |
void |
setSwitchSpecificType(java.lang.Integer value)
An integer that corresponds to a combination of switch-specific settings for this DN. |
void |
setTenant(CfgTenant value)
A unique identifier of the
Tenant
to which this DN belongs. |
void |
setTenantDBID(int dbid)
A unique identifier of the
Tenant
to which this DN belongs. |
void |
setTrunks(java.lang.Integer value)
Number of trunks associated with this DN. |
void |
setType(CfgDNType value)
Type of this DN. |
void |
setUseOverride(CfgFlag value)
An indicator of whether the override value shall be used instead of
the number or name value for accessing this
DN in certain types of routing. |
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 CfgDN(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 CfgDN(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 CfgDN(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 CfgSwitch getSwitch()
Switch
to which this DN belongs. Mandatory. Once specified, cannot
be changed.
public final void setSwitch(CfgSwitch value)
Switch
to which this DN belongs. Mandatory. Once specified, cannot
be changed.
value
- new property valuegetSwitch()
public final void setSwitchDBID(int dbid)
Switch
to which this DN belongs. Mandatory. Once specified, cannot
be changed.
dbid
- DBID identifier of referred objectgetSwitch()
public final java.lang.Integer getSwitchDBID()
public final CfgTenant getTenant()
Tenant
to which this DN belongs. Read-only (set automatically according
to the current value of tenantDBID
of the switch specified in switchDBID
).
See
CfgSwitch
.
public final void setTenant(CfgTenant value)
Tenant
to which this DN belongs. Read-only (set automatically according
to the current value of tenantDBID
of the switch specified in switchDBID
).
See
CfgSwitch
.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
Tenant
to which this DN belongs. Read-only (set automatically according
to the current value of tenantDBID
of the switch specified in switchDBID
).
See
CfgSwitch
.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final CfgDNType getType()
CfgDNType
.
Mandatory. Once specified, cannot be changed.
public final void setType(CfgDNType value)
CfgDNType
.
Mandatory. Once specified, cannot be changed.
value
- new property valuegetType()
public final java.lang.String getNumber()
CFGDestinationLabel
and CFGAccessResource
.
The uniqueness of CFGAccessResource
is defined by combination
of number and DN type. Once specified, cannot be changed. Please
see the comment regarding the parameter DNRange
in
CfgSwitch
.
public final void setNumber(java.lang.String value)
CFGDestinationLabel
and CFGAccessResource
.
The uniqueness of CFGAccessResource
is defined by combination
of number and DN type. Once specified, cannot be changed. Please
see the comment regarding the parameter DNRange
in
CfgSwitch
.
value
- new property valuegetNumber()
public final java.lang.String getAssociation()
public final void setAssociation(java.lang.String value)
value
- new property valuegetAssociation()
public final java.util.Collection<CfgDN> getDestDNs()
CFGRoutingPoint, CFGExtRoutingPoint, CFGServiceNumber,
CFGRoutingQueue
, CFGACDQueue
, CFGVirtACDQueue
,
or CFGVirtRoutingPoint,
and CFGAccessResource
and
shall be set to NULL
for all other values of type
.
When used as an entry in CfgDeltaDN
(see below), it
is a pointer to a list of identifiers of the objects added to the
existing list. The DN for which this list is specified cannot be
added to this list. If DN type is CFGAccessResource
the property must be presented on GUI (Config Manager) with caption _Remote
Resources_.
public final void setDestDNs(java.util.Collection<CfgDN> value)
CFGRoutingPoint, CFGExtRoutingPoint, CFGServiceNumber,
CFGRoutingQueue
, CFGACDQueue
, CFGVirtACDQueue
,
or CFGVirtRoutingPoint,
and CFGAccessResource
and
shall be set to NULL
for all other values of type
.
When used as an entry in CfgDeltaDN
(see below), it
is a pointer to a list of identifiers of the objects added to the
existing list. The DN for which this list is specified cannot be
added to this list. If DN type is CFGAccessResource
the property must be presented on GUI (Config Manager) with caption _Remote
Resources_.
value
- new property valuegetDestDNs()
public final java.util.Collection<java.lang.Integer> getDestDNDBIDs()
public final void setDestDNDBIDs(java.util.Collection<java.lang.Integer> value)
value
- collection of DBID identifiers of referred objectspublic final CfgFlag getLoginFlag()
DNLoginID
below). See CfgFlag
.
The value should not be taken into consideration if DN type is CFGAccessResource
.
public final java.lang.String getDNLoginID()
type
is set to CFGACDPosition
,
CFGExtension
, CFGEAPort
, CFGVoiceMail
,
or CFGMixed
. For type CFGAccessResource
specifies the type of the resource and must be presented on GIU(Configuration Manager)
with caption _Resource Type_
public final void setDNLoginID(java.lang.String value)
type
is set to CFGACDPosition
,
CFGExtension
, CFGEAPort
, CFGVoiceMail
,
or CFGMixed
. For type CFGAccessResource
specifies the type of the resource and must be presented on GIU(Configuration Manager)
with caption _Resource Type_
value
- new property valuegetDNLoginID()
public final CfgDNRegisterFlag getRegisterAll()
CFGDRTrue
by default.
See
CfgDNRegisterFlag
.
public final void setRegisterAll(CfgDNRegisterFlag value)
CFGDRTrue
by default.
See
CfgDNRegisterFlag
.
value
- new property valuegetRegisterAll()
public final CfgDNGroup getGroup()
DN Group
used in number translation.
public final void setGroup(CfgDNGroup value)
DN Group
used in number translation.
value
- new property valuegetGroup()
public final void setGroupDBID(int dbid)
DN Group
used in number translation.
dbid
- DBID identifier of referred objectgetGroup()
public final java.lang.Integer getGroupDBID()
public final java.lang.Integer getTrunks()
type
is set to CFGDestinationLabel
.
public final void setTrunks(java.lang.Integer value)
type
is set to CFGDestinationLabel
.
value
- new property valuegetTrunks()
public final CfgRouteType getRouteType()
CfgRouteType
.
public final void setRouteType(CfgRouteType value)
CfgRouteType
.
value
- new property valuegetRouteType()
public final java.lang.String getOverride()
public final void setOverride(java.lang.String value)
value
- new property valuegetOverride()
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 java.lang.String getName()
CFGACDQueue, CFGRoutingPoint, CFGVirtualACDQueue, CFGVirtualRoutingPoint,
and
CFGRoutingQueue
.
public final void setName(java.lang.String value)
CFGACDQueue, CFGRoutingPoint, CFGVirtualACDQueue, CFGVirtualRoutingPoint,
and
CFGRoutingQueue
.
value
- new property valuegetName()
public final CfgFlag getUseOverride()
override
value shall be used instead of
the number
or name
value for accessing this
DN in certain types of routing. Recommended to be set to CFGTrue
by default.
See
CfgFlag
.
public final void setUseOverride(CfgFlag value)
override
value shall be used instead of
the number
or name
value for accessing this
DN in certain types of routing. Recommended to be set to CFGTrue
by default.
See
CfgFlag
.
value
- new property valuegetUseOverride()
public final java.lang.Integer getSwitchSpecificType()
public final void setSwitchSpecificType(java.lang.Integer value)
value
- new property valuegetSwitchSpecificType()
public final java.util.Collection<CfgDNAccessNumber> getAccessNumbers()
type
is set to CFGExtRoutingPoint
and
CFGAccessResource
. See
CfgDNAccessNumber
.
public final void setAccessNumbers(java.util.Collection<CfgDNAccessNumber> value)
type
is set to CFGExtRoutingPoint
and
CFGAccessResource
. See
CfgDNAccessNumber
.
value
- new property valuegetAccessNumbers()
public final CfgFolder getSite()
Site
(CfgFolder) with which this DN is associated.
public final void setSite(CfgFolder value)
Site
(CfgFolder) with which this DN is associated.
value
- new property valuegetSite()
public final void setSiteDBID(int dbid)
Site
(CfgFolder) with which this DN is associated.
dbid
- DBID identifier of referred objectgetSite()
public final java.lang.Integer getSiteDBID()
public final CfgObjectiveTable getContract()
Cost Contract
(CfgObjectiveTable) with which this DN is associated.
public final void setContract(CfgObjectiveTable value)
Cost Contract
(CfgObjectiveTable) with which this DN is associated.
value
- new property valuegetContract()
public final void setContractDBID(int dbid)
Cost Contract
(CfgObjectiveTable) with which this DN 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 |