|
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.CfgAgentLogin
public class CfgAgentLogin
Agent Logins are unique codes defined within a Switch and assigned to agents. They identify which Agent is working at which Place during a particular working session. Configuration of Agent Logins in the Configuration Database must exactly match the configuration of those Agent Logins in the switching system. Before adding or deleting a particular Agent Login, make sure that the same change was made in the database of the switching system. When you specify Agent Logins as objects in a Switch, they are not associated with any particular agents. Deletion of Agent Login X will cause the following events set out in the order of arrival:
agentLogins
of the agent who
had Agent Login X assigned
Field Summary | |
---|---|
static CfgObjectType |
OBJECT_TYPE
|
Constructor Summary | |
---|---|
CfgAgentLogin(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgAgentLogin(IConfService confService,
ConfObject objData,
boolean isSaved,
java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. |
|
CfgAgentLogin(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.lang.Integer |
getDBID()
An identifier of this object in the Configuration Database. |
java.lang.String |
getLoginCode()
A pointer to the agent login code. |
java.lang.String |
getOverride()
The number used as a substitute of a regular agent login in certain types of routing. |
java.lang.String |
getPassword()
A pointer to the agent login password. |
CfgObjectState |
getState()
Current object state. |
CfgSwitch |
getSwitch()
A unique identifier of the
Switch
to which this agent login 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 agent login. |
CfgTenant |
getTenant()
A unique identifier of the
Tenant
to which this agent login belongs. |
java.lang.Integer |
getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. |
CfgFlag |
getUseOverride()
An indicator of whether the override value shall be used instead of
the loginCode value for accessing this agent login
in certain types of routing. |
KeyValueCollection |
getUserProperties()
|
void |
save()
Synchronizes changes in the class with Configuration Server. |
void |
setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. |
void |
setLoginCode(java.lang.String value)
A pointer to the agent login code. |
void |
setOverride(java.lang.String value)
The number used as a substitute of a regular agent login in certain types of routing. |
void |
setPassword(java.lang.String value)
A pointer to the agent login password. |
void |
setState(CfgObjectState value)
Current object state. |
void |
setSwitch(CfgSwitch value)
A unique identifier of the
Switch
to which this agent login belongs. |
void |
setSwitchDBID(int dbid)
A unique identifier of the
Switch
to which this agent login belongs. |
void |
setSwitchSpecificType(java.lang.Integer value)
An integer that corresponds to a combination of switch-specific settings for this agent login. |
void |
setTenant(CfgTenant value)
A unique identifier of the
Tenant
to which this agent login belongs. |
void |
setTenantDBID(int dbid)
A unique identifier of the
Tenant
to which this agent login belongs. |
void |
setUseOverride(CfgFlag value)
An indicator of whether the override value shall be used instead of
the loginCode value for accessing this agent login
in certain types of routing. |
void |
setUserProperties(KeyValueCollection value)
|
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 CfgAgentLogin(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 CfgAgentLogin(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 CfgAgentLogin(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 agent login belongs. Mandatory. Once specified,
cannot be changed.
public final void setSwitch(CfgSwitch value)
Switch
to which this agent login belongs. Mandatory. Once specified,
cannot be changed.
value
- new property valuegetSwitch()
public final void setSwitchDBID(int dbid)
Switch
to which this agent login 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 agent login belongs. Read-only (set automatically
according to the current value of
tenantDBID
of the switch specified in switchDBID
).
See type
CfgSwitch
.
public final void setTenant(CfgTenant value)
Tenant
to which this agent login belongs. Read-only (set automatically
according to the current value of
tenantDBID
of the switch specified in switchDBID
).
See type
CfgSwitch
.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
Tenant
to which this agent login belongs. Read-only (set automatically
according to the current value of
tenantDBID
of the switch specified in switchDBID
).
See type
CfgSwitch
.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final java.lang.String getLoginCode()
public final void setLoginCode(java.lang.String value)
value
- new property valuegetLoginCode()
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)
public final java.lang.String getOverride()
public final void setOverride(java.lang.String value)
value
- new property valuegetOverride()
public final CfgFlag getUseOverride()
override
value shall be used instead of
the loginCode
value for accessing this agent login
in certain types of routing. Recommended to be set to CFGTrue
by default.
See type
CfgFlag
.
public final void setUseOverride(CfgFlag value)
override
value shall be used instead of
the loginCode
value for accessing this agent login
in certain types of routing. Recommended to be set to CFGTrue
by default.
See type
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.lang.String getPassword()
public final void setPassword(java.lang.String value)
value
- new property valuegetPassword()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |