Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgPerson

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

public class CfgPerson
extends CfgObject

Persons correspond to contact center personnel___including agents___who need access to CTI applications.

The Genesys Framework requires that every person who needs such access be registered in the Configuration Database with an appropriate set of privileges.

Whether a new person is an agent or not shall be specified at the time when the corresponding CfgPerson object is created. It is not possible to change person's status from a non-agent to an agent (or the other way around) once the CfgPerson object has been created.

Deletion of Person X will cause the following events set out in the order of arrival:

A person cannot be deleted as long as it is associated as an account with at least one daemon application (See CfgApplication and ConfSetAccount).

By default, access privileges of a new person will be set according to the following rules:



See also:

CfgDeltaPerson

CfgSkill

CfgAgentLogin

CfgAgentGroup


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgPerson(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgPerson(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgPerson(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
 CfgAddress getAddress()
          Not in use.
 CfgAgentInfo getAgentInfo()
          A pointer to the structure containing agent-specific information.
 java.util.Collection<CfgAppRank> getAppRanks()
          A pointer to the list of the person's ranks with respect to applications (every item of this list is structured as CfgAppRank ).
 CfgFlag getChangePasswordOnNextLogin()
          This field reflects pending request for user to reset his password on next login.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 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 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.
 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 setAddress(CfgAddress value)
          Not in use.
 void setAgentInfo(CfgAgentInfo value)
          A pointer to the structure containing agent-specific information.
 void setAppRanks(java.util.Collection<CfgAppRank> value)
          A pointer to the list of the person's ranks with respect to applications (every item of this list is structured as CfgAppRank ).
 void setChangePasswordOnNextLogin(CfgFlag value)
          This field reflects pending request for user to reset his password on next login.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setEmailAddress(java.lang.String value)
          A pointer to the email address of this person.
 void setEmployeeID(java.lang.String value)
          A pointer to the code identifying this person within the tenant staff.
 void setExternalID(java.lang.String value)
          A pointer to the string used to identify this person in the external systems.
 void setFirstName(java.lang.String value)
          A pointer to the person's first name.
 void setIsAgent(CfgFlag value)
          An indicator of whether the person is an agent.
 void setIsExternalAuth(CfgFlag value)
          This field should reflect authentication method that used for the Person.
 void setLastName(java.lang.String value)
          A pointer to the person's last name.
 void setPassword(java.lang.String value)
          A pointer to the password the person uses to log into a CTI system.
 void setPasswordHashAlgorithm(java.lang.Integer value)
          This is internal field and it should not be changed.
 void setPasswordUpdatingDate(java.lang.Integer value)
          This field contains a timestamp of last known password change, made by user, 0 otherwise.
 void setPhones(CfgPhones value)
          Not in use.
 void setState(CfgObjectState value)
          Current object state.
 void setTenant(CfgTenant value)
          A unique identifier of the Tenant whose employee this person is.
 void setTenantDBID(int dbid)
          A unique identifier of the Tenant whose employee this person is.
 void setUserName(java.lang.String value)
          A pointer to the name the person uses to log into a CTI system.
 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

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgPerson

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

CfgPerson

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

CfgPerson

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

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

setTenant

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

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

setTenantDBID

public final void setTenantDBID(int dbid)
A unique identifier of the Tenant whose employee this person is. Once specified, cannot be changed.

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

getLastName

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

Returns:
property value or null

setLastName

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

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

getFirstName

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

Returns:
property value or null

setFirstName

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

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

getAddress

public final CfgAddress getAddress()
Not in use.

Returns:
property value or null

setAddress

public final void setAddress(CfgAddress value)
Not in use.

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

getPhones

public final CfgPhones getPhones()
Not in use.

Returns:
property value or null

setPhones

public final void setPhones(CfgPhones value)
Not in use.

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

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

setEmployeeID

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

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

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

setUserName

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

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

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

setPassword

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

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

getAppRanks

public final java.util.Collection<CfgAppRank> getAppRanks()
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

setAppRanks

public final void setAppRanks(java.util.Collection<CfgAppRank> value)
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.

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

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

setIsAgent

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

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

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

setAgentInfo

public final void setAgentInfo(CfgAgentInfo value)
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.

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

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

setUserProperties

public final 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.

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

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

setEmailAddress

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

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

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

setExternalID

public final void setExternalID(java.lang.String value)
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.

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

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

setIsExternalAuth

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

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

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

setChangePasswordOnNextLogin

public final void setChangePasswordOnNextLogin(CfgFlag value)
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.

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

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

setPasswordHashAlgorithm

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

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

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

setPasswordUpdatingDate

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

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

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.