|
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.CfgPerson
public class CfgPerson
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:
agentDBIDs
of all agent groups
that included Person X as an agent
memberIDs
of all access groups
that included Person X as a member
CfgApplication
and
ConfSetAccount
).
By default, access privileges of a new person will be set
according to the following rules:
Administrators
of
the Service Provider.
Users
of the Service Provider.
Administrators
of that tenant.
Users
of that tenant.
Everyone
, which cannot
be changed. For specification of access privileges of the above
default groups, refer to comments to object
CfgAccessGroup
in section Access Control
Functions and Data Types
.
DBID
=
100
and tenantDBID
= 1
shall
be pre-defined (scripted) in the Configuration Database before Configuration
Server is started for the first time. This person has Full
Control
permissions with respect to all objects in the Configuration Database,
which cannot be changed. The object that represents this person
cannot be deleted.
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgPerson(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 CfgPerson(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 CfgPerson(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 CfgTenant getTenant()
Tenant
whose employee this person is. Once specified, cannot be
changed.
public final void setTenant(CfgTenant value)
Tenant
whose employee this person is. Once specified, cannot be
changed.
value
- new property valuegetTenant()
public final void setTenantDBID(int dbid)
Tenant
whose employee this person is. Once specified, cannot be
changed.
dbid
- DBID identifier of referred objectgetTenant()
public final java.lang.Integer getTenantDBID()
public final java.lang.String getLastName()
public final void setLastName(java.lang.String value)
value
- new property valuegetLastName()
public final java.lang.String getFirstName()
public final void setFirstName(java.lang.String value)
value
- new property valuegetFirstName()
public final CfgAddress getAddress()
public final void setAddress(CfgAddress value)
value
- new property valuegetAddress()
public final CfgPhones getPhones()
public final void setPhones(CfgPhones value)
value
- new property valuegetPhones()
public final java.lang.String getEmployeeID()
public final void setEmployeeID(java.lang.String value)
value
- new property valuegetEmployeeID()
public final java.lang.String getUserName()
public final void setUserName(java.lang.String value)
value
- new property valuegetUserName()
public final java.lang.String getPassword()
public final void setPassword(java.lang.String value)
value
- new property valuegetPassword()
public final java.util.Collection<CfgAppRank> getAppRanks()
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.
public final void setAppRanks(java.util.Collection<CfgAppRank> value)
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.
value
- new property valuegetAppRanks()
public final CfgFlag getIsAgent()
agentInfo
below). See type CfgFlag
.
public final void setIsAgent(CfgFlag value)
agentInfo
below). See type CfgFlag
.
value
- new property valuegetIsAgent()
public final CfgAgentInfo getAgentInfo()
CfgAgentInfo
. Shall be specified if the
person is an agent and shall be set to NULL
otherwise.
Once specified, cannot be set to NULL
.
public final void setAgentInfo(CfgAgentInfo value)
CfgAgentInfo
. Shall be specified if the
person is an agent and shall be set to NULL
otherwise.
Once specified, cannot be set to NULL
.
value
- new property valuegetAgentInfo()
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)
value
- new property valuegetUserProperties()
public final java.lang.String getEmailAddress()
public final void setEmailAddress(java.lang.String value)
value
- new property valuegetEmailAddress()
public final java.lang.String getExternalID()
public final void setExternalID(java.lang.String value)
value
- new property valuegetExternalID()
public final CfgFlag getIsExternalAuth()
public final void setIsExternalAuth(CfgFlag value)
value
- new property valuegetIsExternalAuth()
public final CfgFlag getChangePasswordOnNextLogin()
public final void setChangePasswordOnNextLogin(CfgFlag value)
value
- new property valuegetChangePasswordOnNextLogin()
public final java.lang.Integer getPasswordHashAlgorithm()
public final void setPasswordHashAlgorithm(java.lang.Integer value)
value
- new property valuegetPasswordHashAlgorithm()
public final java.lang.Integer getPasswordUpdatingDate()
public final void setPasswordUpdatingDate(java.lang.Integer value)
value
- new property valuegetPasswordUpdatingDate()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |