Person (LSPS 3.3 SDK)

java.lang.Object
- com.whitestein.lsps.os.dto.Person

All Implemented Interfaces:

EntityWithId<String>, PersonEntity, Serializable
```
public class Person
extends Object
implements PersonEntity, Serializable
```
Object representing a person with details, roles and substitutions. Substitutions are represented only as first level substitutions (all persons in substitutions have empty substitution sets).

Author:

vgr, rba

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Person()` Creates new instance.
`Person(String loginName)` Creates new `Person` instance with no details.
`Person(String id, String loginName)` Creates new `Person` instance with no details.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addRoleUnitName(RoleUnitName role)` Adds a role.
`boolean`	`equals(Object object)`
`Set<Person>`	`getActivelySubstituted()` Returns a set of all actively substituted persons.
`Set<Person>`	`getActiveSubstitutes()` Returns a set of all active substitutes.
`String`	`getDetail(String name)` Returns the value of a person detail identified by given `name`.
`Map<String,String>`	`getDetails()` Returns a map of person details.
`Set<Person>`	`getDirectlySubstituted()` Returns a set of all directly substituted persons.
`Set<Person>`	`getDirectSubstitutes()` Returns a set of all direct substitutes.
`String`	`getEmail()` Returns the email of the person.
`Long`	`getEntityVersion()` Returns the entity version.
`String`	`getFirstName()` Returns first name of the person.
`String`	`getFullName()` Returns the full name of the person.
`String`	`getFullNameAndLogin()` Returns "full name (login)"
`String`	`getId()` Returns the id of the person.
`String`	`getLastName()` Returns last name of the person.
`String`	`getLoginAndFullName()` Returns "login (full name)"
`String`	`getLoginName()` Returns the login name of the person.
`String`	`getPhone()` Returns the phone of the person.
`Set<String>`	`getRights()` Rights for the person.
`Set<RoleUnitName>`	`getRoleUnitNames()` Returns a set of this person roles.
`int`	`hashCode()`
`boolean`	`isActive()` Returns true if this person 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 true if this person has active substitution.
`void`	`removeRoleUnitName(RoleUnitName role)` Removes a role.
`void`	`setActive(boolean active)` Sets the active flag.
`void`	`setActivelySubstituted(Collection<Person> activelySubstituted)` Sets the actively substitutes persons of this person.
`void`	`setActiveSubstitutes(Collection<Person> activeSubstitutes)` Sets the active substitutes of this person.
`void`	`setDetail(String name, String value)` Sets the detail of the person.
`void`	`setDetails(Map<String,String> details)` Sets the details of this person.
`void`	`setDirectlySubstituted(Collection<Person> directlySubstituted)` Sets the directly substituted persons of this person.
`void`	`setDirectSubstitutes(Collection<Person> directSubstitutes)` Sets the direct substitutes of this person.
`void`	`setEmail(String email)` Sets the email of the person.
`void`	`setEntityVersion(Long entityVersion)` Sets the entity version.
`void`	`setFirstName(String firstName)` Sets the first name of the person.
`void`	`setLastName(String lastName)` Sets the last name of the person.
`void`	`setLoginName(String loginName)`
`void`	`setPhone(String phone)` Sets the phone of the person.
`void`	`setRights(Set<String> rights)` Sets rights.
`void`	`setRoleUnitNames(Collection<RoleUnitName> roles)` Sets the person roles.
`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

- Constructor Detail
  - Person
```
public Person()
```
    Creates new instance.
  - Person
```
public Person(String id,
              String loginName)
```
    Creates new Person instance with no details.
    
    Parameters:
    
    id -
    
    loginName -
    
    Throws:
    
    NullPointerException - if loginName is null
  - Person
```
public Person(String loginName)
```
    Creates new Person instance with no details.
    
    Parameters:
    
    loginName -
    
    Throws:
    
    NullPointerException - if loginName is null
- Method Detail
  - getId
```
public String getId()
```
    Returns the id of the person.
    
    Specified by:
    
    getId in interface EntityWithId<String>
    
    Returns:
    
    The id of the person.
  - 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)
```
    Parameters:
    
    loginName - the loginName to set
  - getEntityVersion
```
public Long getEntityVersion()
```
    Returns the entity version.
    
    Specified by:
    
    getEntityVersion in interface PersonEntity
    
    Returns:
    
    the entity version
  - setEntityVersion
```
public void setEntityVersion(Long entityVersion)
```
    Sets the entity version.
    
    Parameters:
    
    entityVersion -
  - isActive
```
public boolean isActive()
```
    Returns true if this person is active.
    
    Specified by:
    
    isActive in interface PersonEntity
    
    Returns:
    
    true if this person is active
  - setActive
```
public void setActive(boolean active)
```
    Sets the active flag.
    
    Parameters:
    
    active -
  - isSubstitutionActive
```
public boolean isSubstitutionActive()
```
    Returns true if this person has active substitution.
    
    Specified by:
    
    isSubstitutionActive in interface PersonEntity
    
    Returns:
    
    true if this person has active substitution
  - setSubstitutionActive
```
public void setSubstitutionActive(boolean substitutionActive)
```
    Sets the substitution active flag.
    
    Parameters:
    
    substitutionActive -
  - getFullName
```
public String getFullName()
```
    Returns the full name of the person. If the name is not specified, the login name is returned instead.
    
    Returns:
    
    The full name of the person.
  - getFirstName
```
public String getFirstName()
```
    Returns first name of the person.
    
    Specified by:
    
    getFirstName in interface PersonEntity
    
    Returns:
    
    first name of the person
  - setFirstName
```
public void setFirstName(String firstName)
```
    Sets the first name of the person.
    
    Parameters:
    
    firstName -
  - getLastName
```
public String getLastName()
```
    Returns last name of the person.
    
    Specified by:
    
    getLastName in interface PersonEntity
    
    Returns:
    
    last name of the person
  - setLastName
```
public void setLastName(String lastName)
```
    Sets the last name of the person.
    
    Parameters:
    
    lastName -
  - getEmail
```
public String getEmail()
```
    Returns the email of the person.
    
    Specified by:
    
    getEmail in interface PersonEntity
    
    Returns:
    
    the email of the person
  - setEmail
```
public void setEmail(String email)
```
    Sets the email of the person.
    
    Parameters:
    
    email -
  - getPhone
```
public String getPhone()
```
    Returns the phone of the person.
    
    Specified by:
    
    getPhone in interface PersonEntity
    
    Returns:
    
    the phone of the person
  - setPhone
```
public void setPhone(String phone)
```
    Sets the phone of the person.
    
    Parameters:
    
    phone -
  - getDetails
```
public Map<String,String> getDetails()
```
    Returns a map of person details.
    
    Specified by:
    
    getDetails in interface PersonEntity
    
    Returns:
    
    A map of person details.
  - setDetails
```
public void setDetails(Map<String,String> details)
```
    Sets the details of this person.
    
    Parameters:
    
    details -
  - getDetail
```
public String getDetail(String name)
```
    Returns the value of a person detail identified by given name.
    
    Parameters:
    
    name - The name of the person detail.
    
    Returns:
    
    The value of a person detail identified by given name or null if there is no such detail.
  - setDetail
```
public void setDetail(String name,
                      String value)
```
    Sets the detail of the person.
    
    Parameters:
    
    name -
    
    value -
    
    Throws:
    
    NullPointerException - if the name is null
  - getRoleUnitNames
```
public Set<RoleUnitName> getRoleUnitNames()
```
    Returns a set of this person roles.
    
    Specified by:
    
    getRoleUnitNames in interface PersonEntity
    
    Returns:
    
    a set of this person roles
  - setRoleUnitNames
```
public void setRoleUnitNames(Collection<RoleUnitName> roles)
```
    Sets the person roles.
    
    Parameters:
    
    roles -
  - addRoleUnitName
```
public void addRoleUnitName(RoleUnitName role)
```
    Adds a role.
    
    Parameters:
    
    role -
    
    Throws:
    
    NullPointerException - if the role is null
  - removeRoleUnitName
```
public void removeRoleUnitName(RoleUnitName role)
```
    Removes a role.
    
    Parameters:
    
    role -
  - 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)
  - getDirectSubstitutes
```
public Set<Person> getDirectSubstitutes()
```
    Returns a set of all direct substitutes.
    
    Specified by:
    
    getDirectSubstitutes in interface PersonEntity
    
    Returns:
    
    a set of all direct substitutes
  - setDirectSubstitutes
```
public void setDirectSubstitutes(Collection<Person> directSubstitutes)
```
    Sets the direct substitutes of this person. When updating this person only the login-names are taken into account.
    
    Parameters:
    
    directSubstitutes -
  - getDirectlySubstituted
```
public Set<Person> getDirectlySubstituted()
```
    Returns a set of all directly substituted persons.
    
    Specified by:
    
    getDirectlySubstituted in interface PersonEntity
    
    Returns:
    
    a set of all directly substituted persons
  - setDirectlySubstituted
```
public void setDirectlySubstituted(Collection<Person> directlySubstituted)
```
    Sets the directly substituted persons of this person. Not taken into account when updating this person.
    
    Parameters:
    
    directlySubstituted -
  - getActiveSubstitutes
```
public Set<Person> getActiveSubstitutes()
```
    Returns a set of all active substitutes.
    
    Specified by:
    
    getActiveSubstitutes in interface PersonEntity
    
    Returns:
    
    a set of all active substitutes
  - setActiveSubstitutes
```
public void setActiveSubstitutes(Collection<Person> activeSubstitutes)
```
    Sets the active substitutes of this person. Not taken into account when updating this person.
    
    Parameters:
    
    activeSubstitutes -
  - getActivelySubstituted
```
public Set<Person> getActivelySubstituted()
```
    Returns a set of all actively substituted persons.
    
    Specified by:
    
    getActivelySubstituted in interface PersonEntity
    
    Returns:
    
    a set of all actively substituted persons
  - setActivelySubstituted
```
public void setActivelySubstituted(Collection<Person> activelySubstituted)
```
    Sets the actively substitutes persons of this person. Not taken into account when updating this person.
    
    Parameters:
    
    activelySubstituted -
  - equals
```
public boolean equals(Object object)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getLoginAndFullName
```
public String getLoginAndFullName()
```
    Returns "login (full name)"
    
    Returns:
    
    "login (full name)"
  - getFullNameAndLogin
```
public String getFullNameAndLogin()
```
    Returns "full name (login)"
    
    Returns:
    
    "full name (login)"
  - getRights
```
public Set<String> getRights()
```
    Description copied from interface: PersonEntity
    
    Rights for the person.
    
    Specified by:
    
    getRights in interface PersonEntity
    
    Returns:
    
    rights for the person
  - setRights
```
public void setRights(Set<String> rights)
```
    Sets rights.
    
    Parameters:
    
    rights -

Class Person

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Person

Person

Person

Method Detail

getId

getLoginName

setLoginName

getEntityVersion

setEntityVersion

isActive

setActive

isSubstitutionActive

setSubstitutionActive

getFullName

getFirstName

setFirstName

getLastName

setLastName

getEmail

setEmail

getPhone

setPhone

getDetails

setDetails

getDetail

setDetail

getRoleUnitNames

setRoleUnitNames

addRoleUnitName

removeRoleUnitName

isInRole

isInRoles

isStrictlyInRole

isStrictlyInRoles

getDirectSubstitutes

setDirectSubstitutes

getDirectlySubstituted

setDirectlySubstituted

getActiveSubstitutes

setActiveSubstitutes

getActivelySubstituted

setActivelySubstituted

equals

hashCode

toString

getLoginAndFullName

getFullNameAndLogin

getRights

setRights