Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgAgentLogin

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

public class CfgAgentLogin
extends CfgObject

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:



See also:

CfgDeltaAgentLogin

CfgSwitch


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

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgAgentLogin

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

CfgAgentLogin

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

CfgAgentLogin

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

getSwitch

public final CfgSwitch getSwitch()
A unique identifier of the Switch to which this agent login belongs. Mandatory. Once specified, cannot be changed.

Returns:
instance of referred object or null

setSwitch

public final void setSwitch(CfgSwitch value)
A unique identifier of the Switch to which this agent login belongs. Mandatory. Once specified, cannot be changed.

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

setSwitchDBID

public final void setSwitchDBID(int dbid)
A unique identifier of the Switch to which this agent login belongs. Mandatory. Once specified, cannot be changed.

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

getSwitchDBID

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

Returns:
DBID identifier of referred object or null

getTenant

public final CfgTenant getTenant()
A unique identifier of the 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 .

Returns:
instance of referred object or null

setTenant

public final void setTenant(CfgTenant value)
A unique identifier of the 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 .

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

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the 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 .

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

getLoginCode

public final java.lang.String getLoginCode()
A pointer to the agent login code. Mandatory. Must be unique within the switch. Once specified, cannot be changed.

Returns:
property value or null

setLoginCode

public final void setLoginCode(java.lang.String value)
A pointer to the agent login code. Mandatory. Must be unique within the switch. Once specified, cannot be changed.

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

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

setUserProperties

public final void setUserProperties(KeyValueCollection value)

getOverride

public final java.lang.String getOverride()
The number used as a substitute of a regular agent login in certain types of routing.

Returns:
property value or null

setOverride

public final void setOverride(java.lang.String value)
The number used as a substitute of a regular agent login in certain types of routing.

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

getUseOverride

public final 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. Recommended to be set to CFGTrue by default. See type CfgFlag .

Returns:
property value or null

setUseOverride

public final 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. Recommended to be set to CFGTrue by default. See type CfgFlag .

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

getSwitchSpecificType

public final java.lang.Integer getSwitchSpecificType()
An integer that corresponds to a combination of switch-specific settings for this agent login. Cannot be set to a zero or negative value.

Returns:
property value or null

setSwitchSpecificType

public final void setSwitchSpecificType(java.lang.Integer value)
An integer that corresponds to a combination of switch-specific settings for this agent login. Cannot be set to a zero or negative value.

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

getPassword

public final java.lang.String getPassword()
A pointer to the agent login password.

Returns:
property value or null

setPassword

public final void setPassword(java.lang.String value)
A pointer to the agent login password.

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

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.