|
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.CfgDelta
com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaPerson
public class CfgDeltaPerson
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 |
---|
public CfgDeltaPerson(IConfService confService)
confService
- configuration service instancepublic CfgDeltaPerson(IConfService confService, ConfObjectDelta objData)
confService
- configuration service instanceobjData
- configuration protocol object delta datapublic CfgDeltaPerson(IConfService confService, org.w3c.dom.Node xmlData)
confService
- configuration service instancexmlData
- XML object containing object delta dataMethod Detail |
---|
public final java.lang.Integer getDBID()
public final CfgPerson retrieveCfgPerson() throws ConfigException
ConfigException
- in case of problem while object readingpublic final CfgTenant getTenant()
Tenant
whose employee this person is. Once specified, cannot be
changed.
public final java.lang.Integer getTenantDBID()
public final java.lang.String getLastName()
public final java.lang.String getFirstName()
public final CfgAddress getAddress()
public final CfgPhones getPhones()
public final java.lang.String getBirthdate()
public final java.lang.String getComment()
public final java.lang.String getEmployeeID()
public final java.lang.String getUserName()
public final java.lang.String getPassword()
public final java.util.Collection<CfgAppRank> getAddedAppRanks()
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 CfgFlag getIsAgent()
agentInfo
below). See type CfgFlag
.
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 CfgFlag getIsAdmin()
public final java.util.Collection<CfgTenant> getAddedAssignedTenants()
public final java.util.Collection<java.lang.Integer> getAddedAssignedTenantDBIDs()
@Deprecated public final java.util.Collection<java.lang.Integer> getAssignedTenantDBIDs()
getAddedAssignedTenantDBIDs()
public final CfgObjectState getState()
CfgObjectState
public final KeyValueCollection getAddedUserProperties()
public final java.lang.String getEmailAddress()
public final java.lang.String getExternalID()
public final CfgFlag getIsExternalAuth()
public final CfgFlag getChangePasswordOnNextLogin()
public final java.lang.Integer getPasswordHashAlgorithm()
public final java.lang.Integer getPasswordUpdatingDate()
public final CfgDeltaAgentInfo getDeltaAgentInfo()
NULL
otherwise. See structure
CfgDeltaAgentInfo
.
public final java.util.Collection<CfgAppRank> getDeletedAppRanks()
CfgAppType
).
public final java.util.Collection<CfgAppRank> getChangedAppRanks()
CfgAppRank
).
public final java.util.Collection<CfgTenant> getDeletedAssignedTenants()
public final java.util.Collection<java.lang.Integer> getDeletedAssignedTenantDBIDs()
public final KeyValueCollection getDeletedUserProperties()
public final KeyValueCollection getChangedUserProperties()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |