Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaPerson

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

public class CfgDeltaPerson
extends CfgDelta

The changes to make to a CfgPerson object.


Constructor Summary
CfgDeltaPerson(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaPerson(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaPerson(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 java.util.Collection<CfgAppRank> getAddedAppRanks()
          A pointer to the list of the person's ranks with respect to applications (every item of this list is structured as CfgAppRank ).
 java.util.Collection<java.lang.Integer> getAddedAssignedTenantDBIDs()
          Not in use.
 java.util.Collection<CfgTenant> getAddedAssignedTenants()
          Not in use.
 KeyValueCollection getAddedUserProperties()
          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.
 CfgAddress getAddress()
          Not in use.
 CfgAgentInfo getAgentInfo()
          A pointer to the structure containing agent-specific information.
 java.util.Collection<java.lang.Integer> getAssignedTenantDBIDs()
          Deprecated.  
 java.lang.String getBirthdate()
          Not in use.
 java.util.Collection<CfgAppRank> getChangedAppRanks()
          A pointer to the list of changed application ranks (every item of this list is structured as CfgAppRank ).
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 CfgFlag getChangePasswordOnNextLogin()
          This field reflects pending request for user to reset his password on next login.
 java.lang.String getComment()
          Not in use.
 java.lang.Integer getDBID()
          The DBID of the target CfgPerson configuration object.
 java.util.Collection<CfgAppRank> getDeletedAppRanks()
          A pointer to the list of deleted application types (every item of this list has variable type CfgAppType).
 java.util.Collection<java.lang.Integer> getDeletedAssignedTenantDBIDs()
          Not in use.
 java.util.Collection<CfgTenant> getDeletedAssignedTenants()
          Not in use.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined properties.
 CfgDeltaAgentInfo getDeltaAgentInfo()
          A pointer to the structure containing changes made to the agent-specific information of the person.
 java.lang.String getEmailAddress()
          A pointer to the email address of this person.
 java.lang.String getEmployeeID()
          A pointer to the code identifying this person within the tenant staff.
 java.lang.String getExternalID()
          A pointer to the string used to identify this person in the external systems.
 java.lang.String getFirstName()
          A pointer to the person's first name.
 CfgFlag getIsAdmin()
          Not in use.
 CfgFlag getIsAgent()
          An indicator of whether the person is an agent.
 CfgFlag getIsExternalAuth()
          This field should reflect authentication method that used for the Person.
 java.lang.String getLastName()
          A pointer to the person's last name.
 java.lang.String getPassword()
          A pointer to the password the person uses to log into a CTI system.
 java.lang.Integer getPasswordHashAlgorithm()
          This is internal field and it should not be changed.
 java.lang.Integer getPasswordUpdatingDate()
          This field contains a timestamp of last known password change, made by user, 0 otherwise.
 CfgPhones getPhones()
          Not in use.
 CfgObjectState getState()
          Current object state.
 CfgTenant getTenant()
          A unique identifier of the Tenant whose employee this person is.
 java.lang.Integer getTenantDBID()
          Retrieves the dbid of the object that is being linked to by the Tenant property.
 java.lang.String getUserName()
          A pointer to the name the person uses to log into a CTI system.
 CfgPerson retrieveCfgPerson()
          Read base CfgPerson 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

CfgDeltaPerson

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

Parameters:
confService - configuration service instance

CfgDeltaPerson

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

CfgDeltaPerson

public CfgDeltaPerson(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 CfgPerson configuration object.

Returns:
target object DBID

retrieveCfgPerson

public final CfgPerson retrieveCfgPerson()
                                  throws ConfigException
Read base CfgPerson configuration object caused this event.

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

getTenant

public final CfgTenant getTenant()
A unique identifier of the Tenant whose employee this person is. Once specified, cannot be changed.

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

getLastName

public final java.lang.String getLastName()
A pointer to the person's last name. Max length 64 symbols.

Returns:
property value or null

getFirstName

public final java.lang.String getFirstName()
A pointer to the person's first name. Max length 64 symbols.

Returns:
property value or null

getAddress

public final CfgAddress getAddress()
Not in use.

Returns:
property value or null

getPhones

public final CfgPhones getPhones()
Not in use.

Returns:
property value or null

getBirthdate

public final java.lang.String getBirthdate()
Not in use.

Returns:
property value or null

getComment

public final java.lang.String getComment()
Not in use.

Returns:
property value or null

getEmployeeID

public final java.lang.String getEmployeeID()
A pointer to the code identifying this person within the tenant staff. Mandatory. Must be unique within the tenant. Max length 64 symbols.

Returns:
property value or null

getUserName

public final java.lang.String getUserName()
A pointer to the name the person uses to log into a CTI system. Mandatory. Must be unique within the Configuration Database.

Returns:
property value or null

getPassword

public final java.lang.String getPassword()
A pointer to the password the person uses to log into a CTI system. Max length 64 symbols.

Returns:
property value or null

getAddedAppRanks

public final java.util.Collection<CfgAppRank> getAddedAppRanks()
A pointer to the list of the person's ranks with respect to applications (every item of this list is structured as CfgAppRank ). When used as an entry in CfgDeltaPerson (see below), it is a pointer to a list of the ranks added to the existing list.

Returns:
list of structures or null

getIsAgent

public final CfgFlag getIsAgent()
An indicator of whether the person is an agent. Read-only (set automatically according to the current value of agentInfo below). See type CfgFlag.

Returns:
property value or null

getAgentInfo

public final CfgAgentInfo getAgentInfo()
A pointer to the structure containing agent-specific information. See structure CfgAgentInfo . Shall be specified if the person is an agent and shall be set to NULL otherwise. Once specified, cannot be set to NULL.

Returns:
property value or null

getIsAdmin

public final CfgFlag getIsAdmin()
Not in use.

Returns:
property value or null

getAddedAssignedTenants

public final java.util.Collection<CfgTenant> getAddedAssignedTenants()
Not in use.

Returns:
list of configuration objects or null

getAddedAssignedTenantDBIDs

public final java.util.Collection<java.lang.Integer> getAddedAssignedTenantDBIDs()
Not in use.

Returns:
collection of DBID identifiers of referred objects or null

getAssignedTenantDBIDs

@Deprecated
public final java.util.Collection<java.lang.Integer> getAssignedTenantDBIDs()
Deprecated. 

See Also:
getAddedAssignedTenantDBIDs()

getState

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

Returns:
property value or null

getAddedUserProperties

public final KeyValueCollection getAddedUserProperties()
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.

Returns:
property value or null

getEmailAddress

public final java.lang.String getEmailAddress()
A pointer to the email address of this person. Max length 255 symbols.

Returns:
property value or null

getExternalID

public final java.lang.String getExternalID()
A pointer to the string used to identify this person in the external systems. In particular, this field used to store an identifier processed during the authentication in the LDAP repositories.Max length 255 symbols.

Returns:
property value or null

getIsExternalAuth

public final CfgFlag getIsExternalAuth()
This field should reflect authentication method that used for the Person. If external authentication is used this flag should be equal to CFGTrue.

Returns:
property value or null

getChangePasswordOnNextLogin

public final CfgFlag getChangePasswordOnNextLogin()
This field reflects pending request for user to reset his password on next login. If user has reset its password this field set to CFGTrue.

Returns:
property value or null

getPasswordHashAlgorithm

public final java.lang.Integer getPasswordHashAlgorithm()
This is internal field and it should not be changed. Server ignores attempt to modify this field.

Returns:
property value or null

getPasswordUpdatingDate

public final java.lang.Integer getPasswordUpdatingDate()
This field contains a timestamp of last known password change, made by user, 0 otherwise.

Returns:
property value or null

getDeltaAgentInfo

public final CfgDeltaAgentInfo getDeltaAgentInfo()
A pointer to the structure containing changes made to the agent-specific information of the person. Makes sense only if the person is an agent and shall be set to NULL otherwise. See structure CfgDeltaAgentInfo .

Returns:
property value or null

getDeletedAppRanks

public final java.util.Collection<CfgAppRank> getDeletedAppRanks()
A pointer to the list of deleted application types (every item of this list has variable type CfgAppType).

Returns:
list of numeric values or null

getChangedAppRanks

public final java.util.Collection<CfgAppRank> getChangedAppRanks()
A pointer to the list of changed application ranks (every item of this list is structured as CfgAppRank ).

Returns:
list of structures or null

getDeletedAssignedTenants

public final java.util.Collection<CfgTenant> getDeletedAssignedTenants()
Not in use.

Returns:
list of configuration objects or null

getDeletedAssignedTenantDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedAssignedTenantDBIDs()
Not in use.

Returns:
collection of DBID identifiers of referred objects 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.