|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface Person
Representation of a person in the Agent Interaction Layer.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface com.genesyslab.ail.IdObject |
|---|
IdObject.ObjectType |
| Method Summary | |
|---|---|
boolean |
changePassword(java.lang.String old_password,
java.lang.String new_password)
Changes the password of this person. |
boolean |
checkPassword(java.lang.String password)
Checks the password of this person. |
java.util.Map |
getAnnex()
Returns additional information about this person. |
java.lang.String |
getEmployeeId()
Returns the employee ID of this person. |
java.lang.String |
getFirstName()
Returns the first name of this person. |
java.lang.String |
getLastName()
Returns the last name of this person. |
int |
getLastPasswordErrorCode()
Returns the error code associated with the last password action. |
java.lang.String |
getLastPasswordReason()
Returns additional information about the last password action. |
java.lang.Integer |
getTenantId()
Returns the identifier of the Tenant to which this person beongs. |
java.lang.String |
getUserName()
Returns the user name of this person. |
boolean |
isAgent()
Returns true if this Person is actually an agent. |
boolean |
isEnabled()
Returns the Configuration Layer status of the Person object. |
boolean |
isLastPasswordErrorCodeExternal()
Returns true if an external server made the authentication. |
void |
setAnnex(java.util.Map annex)
Sets the person's annex. |
| Methods inherited from interface com.genesyslab.ail.IdObject |
|---|
getId, getObjectType |
| Methods inherited from interface com.genesyslab.ail.ConfigObject |
|---|
exists |
| Method Detail |
|---|
java.lang.String getFirstName()
java.lang.String getLastName()
java.lang.String getEmployeeId()
getUserName()java.lang.String getUserName()
user name of this person. The user name is another
name for the ID. Returns the same value as getId().
boolean isAgent()
true if this Person is actually an agent. In this case, the
object can be casted onto Agent in order to access agent-related methods.
java.util.Map getAnnex()
void setAnnex(java.util.Map annex)
throws RequestFailedException
A call to this method replaces all prior annexes with the new specified annexes.
If you need to modify only a few values, first get the annex by calling the getAnnex() method.
Then make your changes to returned Map and call this setAnnex() method.
This modification is then committed to the Configuration Layer.
annex - Map of key-value pairs. Keys are String objects.
For details on valid values, refer to AbstractInteraction.setAttachedData(java.lang.String, java.lang.Object).
InvalidParameterException - exception thrown if a key is not a String object.
ConfigServiceException - if there is a problem with the Configuration Service.
RequestFailedExceptionboolean checkPassword(java.lang.String password)
getLastPasswordReason() to get additional information on the
result of this method.
password - the password to test.
true if this password is correct.
boolean changePassword(java.lang.String old_password,
java.lang.String new_password)
getLastPasswordReason() to get additional information on the
result of this method.
old_password - the current password.new_password - the new password to set.
true if the password was successfully changed.java.lang.String getLastPasswordReason()
checkPassword(java.lang.String) or changePassword(java.lang.String, java.lang.String).
int getLastPasswordErrorCode()
checkPassword(java.lang.String) or changePassword(java.lang.String, java.lang.String) returned false.
Note: This method returns -1 if the last password action was successful.
boolean isLastPasswordErrorCodeExternal()
true if an external server made the authentication.
Call this method if checkPassword(java.lang.String) or changePassword(java.lang.String, java.lang.String) returned
false.
Note: The method returns false if the last password action
was successful.
boolean isEnabled()
Person object.
Person object is enabled in the Configuration Layer.java.lang.Integer getTenantId()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||