Person (LSPS 3.3 SDK)

java.lang.Object
- com.whitestein.lsps.orgstructure.entity.Person

All Implemented Interfaces:

EntityWithId<String>, PersonEntity
```
@Entity
public class Person
extends Object
implements PersonEntity
```
Persistent entity representing a person.

Since:

1.1

Author:

vgr, rba

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`CHECK_ACTIVE_PERSONS_WITH_LOGIN_EXISTS` Query name.
`static String`	`FIND_ALL` Query name.
`static String`	`FIND_BY_LOGIN` Query name.
`static String`	`FIND_LIKE_ID` Query name.
`static String`	`FIND_PERSONS_FOR_SECURITY_ROLE` Query name.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Person()` Constructor needed for JPA-specific purposes.
	`Person(String id, String loginName)` Creates new `Person` instance with the empty map of details.
	`Person(String id, String loginName, Map<String,String> details)` Creates new `Person` instance with given map of details.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Person`	`addRole(Role role)` Adds given `role` to the roles the person is assigned to.
`void`	`addSecurityRole(SecurityRole securityRole)` Adds a security role.
`Person`	`addSubstitute(Person substitute)` Adds a substitute.
`boolean`	`equals(Object obj)`
`Set<Person>`	`getActivelySubstituted()` Returns a collection of all actively substituted persons including transitive substitutions.
`Set<Person>`	`getActiveSubstitutes()` Returns a set of active substitutes of this person including transitive substitutions.
`String`	`getDetail(String detailName)` Returns a value of the detail with given `detailName` or `null` if there is no such detail.
`Map<String,String>`	`getDetails()` Returns a map of details (name-value pairs) of the person.
`Set<Person>`	`getDirectlySubstituted()` Returns a collection of directly substituted Persons for this Person.
`Set<Person>`	`getDirectSubstitutes()` Returns a set of substitutes of this Person.
`String`	`getEmail()` Returns the email.
`Long`	`getEntityVersion()` Returns the entity version.
`String`	`getFirstName()` Returns the first name.
`String`	`getId()` Returns the primary key.
`String`	`getLastName()` Returns the last name.
`String`	`getLoginName()` Returns the login name of the person.
`String`	`getPasswordHash()`
`String`	`getPasswordSalt()`
`String`	`getPhone()` Returns the phone.
`Set<String>`	`getRights()` Returns a set of this person rights.
`Role`	`getRole(RoleUnitName roleName)` Returns the role which corresponds to given `roleName` or `null` if the person contains no such role.
`Collection<Role>`	`getRoles()` Returns a collection of roles the person is assigned to.
`Set<RoleUnitName>`	`getRoleUnitNames()` Returns a set of role unit names.
`Collection<SecurityRole>`	`getSecurityRoles()` Returns a collection of the security roles that are assigned to the user.
`byte[]`	`getSetting(String settingName)` Returns the content of the setting with given `detailName` or `null` if there is no such setting.
`Map<String,byte[]>`	`getSettings()` Returns a map of settings (name-value pairs) of the person.
`boolean`	`hasDetail(String detailName)` Returns `true` if this person has the detail (identified by given `detailName`), otherwise returns `false`.
`int`	`hashCode()`
`boolean`	`hasRight(String right)` Returns true if this person has the given right.
`boolean`	`isActive()` Returns true if the user is active.
`boolean`	`isInRole(RoleUnitName role)` Return true if this person is in the given role, i.e.
`boolean`	`isInRoles(Collection<RoleUnitName> roles)` Returns true if this person is at least in one of the given roles.
`boolean`	`isStrictlyInRole(RoleUnitName role)` Returns true if this person is strictly in the given role, i.e.
`boolean`	`isStrictlyInRoles(Collection<RoleUnitName> roles)` Returns true if this person is strictly at least in one of the given roles.
`boolean`	`isSubstitutionActive()` Returns the substitution active flag.
`PersonDetail`	`removeDetail(String detailName)` Removes the detail identified by given `detailName` and returns the `PersonDetail` instance (JPA entity) that has just been removed.
`Person`	`removeRole(Role role)` Removes given `role` from the roles the person is assigned to.
`void`	`removeSecurityRole(SecurityRole securityRole)` Removes a security role.
`void`	`removeSetting(String settingName)` Removes the setting identified by given `settingName` and returns the `PersonDetail` instance (JPA entity) that has just been removed.
`Person`	`removeSubstitute(Person substitute)` Removes a substitute.
`void`	`setActive(boolean active)` Sets the active flag.
`Person`	`setDetail(String detailName, String detailValue)` Adds or updates the detail identified by given `detailName`.
`void`	`setEmail(String email)` Sets the email.
`void`	`setFirstName(String firstName)` Sets the first name.
`void`	`setLastName(String lastName)` Sets the last name.
`void`	`setLoginName(String loginName)` Sets the login of the user.
`void`	`setPasswordHash(String passwordHash)`
`void`	`setPasswordSalt(String passwordSalt)`
`void`	`setPhone(String phone)` Sets the phone
`void`	`setSecurityRoles(Collection<SecurityRole> securityRoles)` Sets security roles.
`Person`	`setSetting(String settingName, byte[] settingContent)` Adds or updates the setting identified by given `settingName`.
`void`	`setSubstitutes(Collection<Person> substitutes)` Sets a new set of substitutes for this Person.
`void`	`setSubstitutionActive(boolean substitutionActive)` Sets the substitution active flag.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - FIND_ALL
```
public static final String FIND_ALL
```
    Query name.
    
    See Also:
    
    Constant Field Values
  - FIND_BY_LOGIN
```
public static final String FIND_BY_LOGIN
```
    Query name.
    
    See Also:
    
    Constant Field Values
  - FIND_LIKE_ID
```
public static final String FIND_LIKE_ID
```
    Query name.
    
    See Also:
    
    Constant Field Values
  - FIND_PERSONS_FOR_SECURITY_ROLE
```
public static final String FIND_PERSONS_FOR_SECURITY_ROLE
```
    Query name.
    
    See Also:
    
    Constant Field Values
  - CHECK_ACTIVE_PERSONS_WITH_LOGIN_EXISTS
```
public static final String CHECK_ACTIVE_PERSONS_WITH_LOGIN_EXISTS
```
    Query name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Person
```
protected Person()
```
    Constructor needed for JPA-specific purposes.
  - Person
```
public Person(String id,
              String loginName)
```
    Creates new Person instance with the empty map of details.
    
    Parameters:
    
    id -
    
    loginName -
    
    Throws:
    
    NullPointerException - if loginName is null
  - Person
```
public Person(String id,
              String loginName,
              Map<String,String> details)
```
    Creates new Person instance with given map of details.
    
    Parameters:
    
    id -
    
    loginName -
    
    details -
    
    Throws:
    
    NullPointerException - if loginName is null
- Method Detail
  - getId
```
public String getId()
```
    Description copied from interface: EntityWithId
    
    Returns the primary key.
    
    Specified by:
    
    getId in interface EntityWithId<String>
    
    Returns:
    
    the primary key
  - getLoginName
```
public String getLoginName()
```
    Returns the login name of the person.
    
    Specified by:
    
    getLoginName in interface PersonEntity
    
    Returns:
    
    The login name of the person.
  - setLoginName
```
public void setLoginName(String loginName)
```
    Sets the login of the user.
    
    Parameters:
    
    loginName - The new login of the user in its plain form. Cannot be null.
    
    Throws:
    
    NullPointerException - (unchecked) If loginName is null.
  - getEntityVersion
```
public Long getEntityVersion()
```
    Returns the entity version.
    
    Specified by:
    
    getEntityVersion in interface PersonEntity
    
    Returns:
    
    the entity version
  - getFirstName
```
public String getFirstName()
```
    Returns the first name.
    
    Specified by:
    
    getFirstName in interface PersonEntity
    
    Returns:
    
    the first name
  - setFirstName
```
public void setFirstName(String firstName)
```
    Sets the first name.
    
    Parameters:
    
    firstName -
  - getLastName
```
public String getLastName()
```
    Returns the last name.
    
    Specified by:
    
    getLastName in interface PersonEntity
    
    Returns:
    
    the last name
  - setLastName
```
public void setLastName(String lastName)
```
    Sets the last name.
    
    Parameters:
    
    lastName -
  - getEmail
```
public String getEmail()
```
    Returns the email.
    
    Specified by:
    
    getEmail in interface PersonEntity
    
    Returns:
    
    the email
  - setEmail
```
public void setEmail(String email)
```
    Sets the email.
    
    Parameters:
    
    email -
  - getPhone
```
public String getPhone()
```
    Returns the phone.
    
    Specified by:
    
    getPhone in interface PersonEntity
    
    Returns:
    
    the phone
  - setPhone
```
public void setPhone(String phone)
```
    Sets the phone
    
    Parameters:
    
    phone -
  - getPasswordHash
```
public String getPasswordHash()
```
    Returns:
    
    the passwordHash
  - setPasswordHash
```
public void setPasswordHash(String passwordHash)
```
    Parameters:
    
    passwordHash - the passwordHash to set
  - getPasswordSalt
```
public String getPasswordSalt()
```
    Returns:
    
    the passwordSalt
  - setPasswordSalt
```
public void setPasswordSalt(String passwordSalt)
```
    Parameters:
    
    passwordSalt - the passwordSalt to set
  - isActive
```
public boolean isActive()
```
    Returns true if the user is active.
    
    Specified by:
    
    isActive in interface PersonEntity
    
    Returns:
    
    true if the user is active
  - setActive
```
public void setActive(boolean active)
```
    Sets the active flag.
    
    Parameters:
    
    active -
  - getDetails
```
public Map<String,String> getDetails()
```
    Returns a map of details (name-value pairs) of the person.
    
    Specified by:
    
    getDetails in interface PersonEntity
    
    Returns:
    
    A map of details (name-value pairs) of the person.
  - hasDetail
```
public boolean hasDetail(String detailName)
```
    Returns true if this person has the detail (identified by given detailName), otherwise returns false.
    
    Parameters:
    
    detailName - The name of the detail to check for presence.
    
    Returns:
    
    true if this person has the detail (identified by given detailName), otherwise returns false.
  - getSettings
```
public Map<String,byte[]> getSettings()
```
    Returns a map of settings (name-value pairs) of the person.
    
    Returns:
    
    A map of settings (name-value pairs) of the person.
  - getSetting
```
public byte[] getSetting(String settingName)
```
    Returns the content of the setting with given detailName or null if there is no such setting.
    
    Parameters:
    
    settingName - The name of the setting to retrieve. Cannot be null.
    
    Returns:
    
    The content of the setting with given settingName or null if there is no such detail.
    
    Throws:
    
    NullPointerException - (unchecked) If settingName is null.
  - setSetting
```
public Person setSetting(String settingName,
                         byte[] settingContent)
```
    Adds or updates the setting identified by given settingName. If the setting does not exist in the person's settings, it will be added there, otherwise the setting will be updated to the new value (with given settingContent).
    
    Parameters:
    
    settingName - The name of the setting to be added or updated. Cannot be null.
    
    settingContent - The new value of the setting to add or update. Cannot be null.
    
    Returns:
    
    Current Person instance.
    
    Throws:
    
    NullPointerException - (unchecked) If at least one of the arguments is null.
  - removeSetting
```
public void removeSetting(String settingName)
```
    Removes the setting identified by given settingName and returns the PersonDetail instance (JPA entity) that has just been removed.
    
    Parameters:
    
    settingName - The name of the setting to remove from this person.
  - getDetail
```
public String getDetail(String detailName)
```
    Returns a value of the detail with given detailName or null if there is no such detail.
    
    Parameters:
    
    detailName - The name of the detail to retrieve. Cannot be null.
    
    Returns:
    
    A value of the detail with given detailName or null if there is no such detail.
    
    Throws:
    
    NullPointerException - (unchecked) If detailName is null.
  - setDetail
```
public Person setDetail(String detailName,
                        String detailValue)
```
    Adds or updates the detail identified by given detailName. If the detail does not exist in the person's details, it will be added there, otherwise the detail will be updated to the new value (with given detailValue).
    
    Parameters:
    
    detailName - The name of the detail to be added or updated. Cannot be null.
    
    detailValue - The new value of the detail to add or update. Cannot be null.
    
    Returns:
    
    Current Person instance.
    
    Throws:
    
    NullPointerException - (unchecked) If at least one of the arguments is null.
  - removeDetail
```
public PersonDetail removeDetail(String detailName)
```
    Removes the detail identified by given detailName and returns the PersonDetail instance (JPA entity) that has just been removed.
    
    Parameters:
    
    detailName - The name of the detail to remove from this person.
    
    Returns:
    
    Removed PersonDetail instance (JPA entity).
  - getRoles
```
public Collection<Role> getRoles()
```
    Returns a collection of roles the person is assigned to.
    
    Returns:
    
    A collection of roles the person is assigned to.
  - getRoleUnitNames
```
public Set<RoleUnitName> getRoleUnitNames()
```
    Returns a set of role unit names.
    
    Specified by:
    
    getRoleUnitNames in interface PersonEntity
    
    Returns:
    
    a set of role unit names
  - isInRole
```
public boolean isInRole(RoleUnitName role)
```
    Return true if this person is in the given role, i.e. contains a role which matches the given role.
    
    Parameters:
    
    role -
    
    Returns:
    
    true if this person is in the given role
    
    Throws:
    
    NullPointerException - if role is null
  - isInRoles
```
public boolean isInRoles(Collection<RoleUnitName> roles)
```
    Returns true if this person is at least in one of the given roles.
    
    Parameters:
    
    roles -
    
    Returns:
    
    true if this person is at least in one of the given roles
    
    Throws:
    
    NullPointerException - if roles or any element of roles is null
    
    See Also:
    
    isInRole(RoleUnitName)
  - isStrictlyInRole
```
public boolean isStrictlyInRole(RoleUnitName role)
```
    Returns true if this person is strictly in the given role, i.e. contains a role which is equal to the given role.
    
    Parameters:
    
    role -
    
    Returns:
    
    true if this person is strictly in the given role
    
    Throws:
    
    NullPointerException - if role is null
  - isStrictlyInRoles
```
public boolean isStrictlyInRoles(Collection<RoleUnitName> roles)
```
    Returns true if this person is strictly at least in one of the given roles.
    
    Parameters:
    
    roles -
    
    Returns:
    
    true if this person is strictly at least in one of the given roles
    
    Throws:
    
    NullPointerException - if roles or any element of roles is null
    
    See Also:
    
    isStrictlyInRole(RoleUnitName)
  - addRole
```
public Person addRole(Role role)
```
    Adds given role to the roles the person is assigned to.
    
    Parameters:
    
    role - The role to add to the roles the person is assigned to.
    
    Returns:
    
    This instance.
  - getRole
```
public Role getRole(RoleUnitName roleName)
```
    Returns the role which corresponds to given roleName or null if the person contains no such role.
    
    Parameters:
    
    roleName - The name of the role to get.
    
    Returns:
    
    The role which corresponds to given roleName or null.
    
    Throws:
    
    NullPointerException - (unchecked) If roleName is null.
  - removeRole
```
public Person removeRole(Role role)
```
    Removes given role from the roles the person is assigned to.
    
    Parameters:
    
    role - The role to remove from the roles the person is assigned to.
    
    Returns:
    
    This instance.
  - getDirectSubstitutes
```
public Set<Person> getDirectSubstitutes()
```
    Returns a set of substitutes of this Person.
    
    Specified by:
    
    getDirectSubstitutes in interface PersonEntity
    
    Returns:
    
    collection of substitutes
  - getDirectlySubstituted
```
public Set<Person> getDirectlySubstituted()
```
    Returns a collection of directly substituted Persons for this Person.
    
    Specified by:
    
    getDirectlySubstituted in interface PersonEntity
    
    Returns:
    
    collection of substituted Persons
  - getActiveSubstitutes
```
public Set<Person> getActiveSubstitutes()
```
    Returns a set of active substitutes of this person including transitive substitutions.
    
    Specified by:
    
    getActiveSubstitutes in interface PersonEntity
    
    Returns:
    
    a set of active substitutes of this person including transitive substitutions
  - getActivelySubstituted
```
public Set<Person> getActivelySubstituted()
```
    Returns a collection of all actively substituted persons including transitive substitutions.
    
    Specified by:
    
    getActivelySubstituted in interface PersonEntity
    
    Returns:
    
    a collection of all actively substituted persons including transitive substitutions
  - setSubstitutes
```
public void setSubstitutes(Collection<Person> substitutes)
```
    Sets a new set of substitutes for this Person.
    
    Parameters:
    
    substitutes - The set of substitutes for this person.
  - addSubstitute
```
public Person addSubstitute(Person substitute)
```
    Adds a substitute.
    
    Parameters:
    
    substitute -
    
    Returns:
    
    this
  - removeSubstitute
```
public Person removeSubstitute(Person substitute)
```
    Removes a substitute.
    
    Parameters:
    
    substitute -
    
    Returns:
    
    this
  - isSubstitutionActive
```
public boolean isSubstitutionActive()
```
    Returns the substitution active flag.
    
    Specified by:
    
    isSubstitutionActive in interface PersonEntity
    
    Returns:
    
    the substitution active flag
  - setSubstitutionActive
```
public void setSubstitutionActive(boolean substitutionActive)
```
    Sets the substitution active flag.
    
    Parameters:
    
    substitutionActive -
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getSecurityRoles
```
public Collection<SecurityRole> getSecurityRoles()
```
    Returns a collection of the security roles that are assigned to the user.
    
    Returns:
    
    A collection of the security roles that are assigned to the user.
  - setSecurityRoles
```
public void setSecurityRoles(Collection<SecurityRole> securityRoles)
```
    Sets security roles.
    
    Parameters:
    
    securityRoles -
    
    Throws:
    
    NullPointerException - if any role in securityRoles is null
  - addSecurityRole
```
public void addSecurityRole(SecurityRole securityRole)
```
    Adds a security role.
    
    Parameters:
    
    securityRole -
    
    Throws:
    
    NullPointerException - if securityRole is null
  - removeSecurityRole
```
public void removeSecurityRole(SecurityRole securityRole)
```
    Removes a security role.
    
    Parameters:
    
    securityRole -
    
    Throws:
    
    NullPointerException - if securityRole is null
  - getRights
```
public Set<String> getRights()
```
    Returns a set of this person rights.
    
    Specified by:
    
    getRights in interface PersonEntity
    
    Returns:
    
    a set of this person rights
  - hasRight
```
public boolean hasRight(String right)
```
    Returns true if this person has the given right.
    
    Parameters:
    
    right -
    
    Returns:
    
    true if this person has the given right
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class Person

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FIND_ALL

FIND_BY_LOGIN

FIND_LIKE_ID

FIND_PERSONS_FOR_SECURITY_ROLE

CHECK_ACTIVE_PERSONS_WITH_LOGIN_EXISTS

Constructor Detail

Person

Person

Person

Method Detail

getId

getLoginName

setLoginName

getEntityVersion

getFirstName

setFirstName

getLastName

setLastName

getEmail

setEmail

getPhone

setPhone

getPasswordHash

setPasswordHash

getPasswordSalt

setPasswordSalt

isActive

setActive

getDetails

hasDetail

getSettings

getSetting

setSetting

removeSetting

getDetail

setDetail

removeDetail

getRoles

getRoleUnitNames

isInRole

isInRoles

isStrictlyInRole

isStrictlyInRoles

addRole

getRole

removeRole

getDirectSubstitutes

getDirectlySubstituted

getActiveSubstitutes

getActivelySubstituted

setSubstitutes

addSubstitute

removeSubstitute

isSubstitutionActive

setSubstitutionActive

toString

getSecurityRoles

setSecurityRoles

addSecurityRole

removeSecurityRole

getRights

hasRight

hashCode

equals