Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaAgentLogin

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.CfgDelta
              extended by com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaAgentLogin
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaAgentLogin
extends CfgDelta

The changes to make to a CfgAgentLogin object.


Constructor Summary
CfgDeltaAgentLogin(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaAgentLogin(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaAgentLogin(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 KeyValueCollection getAddedUserProperties()
           
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 java.lang.Integer getDBID()
          The DBID of the target CfgAgentLogin configuration object.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 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.
 CfgAgentLogin retrieveCfgAgentLogin()
          Read base CfgAgentLogin configuration object caused this event.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgDelta
ensureDataBackup, retrieveObject, save, toStringProperties, update
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, 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, 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
 

Constructor Detail

CfgDeltaAgentLogin

public CfgDeltaAgentLogin(IConfService confService)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance

CfgDeltaAgentLogin

public CfgDeltaAgentLogin(IConfService confService,
                          ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object delta data

CfgDeltaAgentLogin

public CfgDeltaAgentLogin(IConfService confService,
                          org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object delta data
Method Detail

getDBID

public final java.lang.Integer getDBID()
The DBID of the target CfgAgentLogin configuration object.

Returns:
target object DBID

retrieveCfgAgentLogin

public final CfgAgentLogin retrieveCfgAgentLogin()
                                          throws ConfigException
Read base CfgAgentLogin configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

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

getSwitchDBID

public final java.lang.Integer getSwitchDBID()
Retrieves the dbid of the object that is being linked to by the Switch property. Configuration server provides it only if the property value has been changed.

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

getTenantDBID

public final java.lang.Integer getTenantDBID()
Retrieves the dbid of the object that is being linked to by the Tenant property. Configuration server provides it only if the property value has been changed.

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

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

getAddedUserProperties

public final KeyValueCollection getAddedUserProperties()

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

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

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

getPassword

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

Returns:
property value or null

getDeletedUserProperties

public final KeyValueCollection getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. Has the same structure as parameter userProperties.

Returns:
property value or null

getChangedUserProperties

public final KeyValueCollection getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. Has the same structure as parameter userProperties

Returns:
property value or null

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.