com.whitestein.lsps.os.dto

Class Person

java.lang.Object

com.whitestein.lsps.os.dto.Person

All Implemented Interfaces:

EntityWithId<java.lang.String>, PersonEntity, java.io.Serializable

public class Person
extends java.lang.Object
implements PersonEntity, java.io.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(java.lang.String loginName) Creates new Person instance with no details.
Person(java.lang.String id, java.lang.String loginName) Creates new Person instance with no details.

Method Summary

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

Creates new Person instance with no details.

Parameters:

id -

loginName -

Throws:

java.lang.NullPointerException - if loginName is null

Person

public Person(java.lang.String loginName)

Creates new Person instance with no details.

Parameters:

loginName -

Throws:

java.lang.NullPointerException - if loginName is null

Method Detail

getId

public java.lang.String getId()

Returns the id of the person.

Specified by:

getId in interface EntityWithId<java.lang.String>

Returns:

The id of the person.

getLoginName

public java.lang.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(java.lang.String loginName)

Parameters:

loginName - the loginName to set

getEntityVersion

public java.lang.Long getEntityVersion()

Returns the entity version.

Specified by:

getEntityVersion in interface PersonEntity

Returns:

the entity version

setEntityVersion

public void setEntityVersion(java.lang.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 java.lang.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 java.lang.String getFirstName()

Returns first name of the person.

Specified by:

getFirstName in interface PersonEntity

Returns:

first name of the person

setFirstName

public void setFirstName(java.lang.String firstName)

Sets the first name of the person.

Parameters:

firstName -

getLastName

public java.lang.String getLastName()

Returns last name of the person.

Specified by:

getLastName in interface PersonEntity

Returns:

last name of the person

setLastName

public void setLastName(java.lang.String lastName)

Sets the last name of the person.

Parameters:

lastName -

getEmail

public java.lang.String getEmail()

Returns the email of the person.

Specified by:

getEmail in interface PersonEntity

Returns:

the email of the person

setEmail

public void setEmail(java.lang.String email)

Sets the email of the person.

Parameters:

email -

getPhone

public java.lang.String getPhone()

Returns the phone of the person.

Specified by:

getPhone in interface PersonEntity

Returns:

the phone of the person

setPhone

public void setPhone(java.lang.String phone)

Sets the phone of the person.

Parameters:

phone -

getDetails

public java.util.Map<java.lang.String,java.lang.String> getDetails()

Returns a map of person details.

Specified by:

getDetails in interface PersonEntity

Returns:

A map of person details.

setDetails

public void setDetails(java.util.Map<java.lang.String,java.lang.String> details)

Sets the details of this person.

Parameters:

details -

getDetail

public java.lang.String getDetail(java.lang.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(java.lang.String name,
                      java.lang.String value)

Sets the detail of the person.

Parameters:

name -

value -

Throws:

java.lang.NullPointerException - if the name is null

getRoleUnitNames

public java.util.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(java.util.Collection<RoleUnitName> roles)

Sets the person roles.

Parameters:

roles -

addRoleUnitName

public void addRoleUnitName(RoleUnitName role)

Adds a role.

Parameters:

role -

Throws:

java.lang.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:

java.lang.NullPointerException - if role is null

isInRoles

public boolean isInRoles(java.util.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:

java.lang.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:

java.lang.NullPointerException - if role is null

isStrictlyInRoles

public boolean isStrictlyInRoles(java.util.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:

java.lang.NullPointerException - if roles or any element of roles is null

See Also:

isStrictlyInRole(RoleUnitName)

getDirectSubstitutes

public java.util.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(java.util.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 java.util.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(java.util.Collection<Person> directlySubstituted)

Sets the directly substituted persons of this person. Not taken into account when updating this person.

Parameters:

directlySubstituted -

getActiveSubstitutes

public java.util.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(java.util.Collection<Person> activeSubstitutes)

Sets the active substitutes of this person. Not taken into account when updating this person.

Parameters:

activeSubstitutes -

getActivelySubstituted

public java.util.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(java.util.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(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLoginAndFullName

public java.lang.String getLoginAndFullName()

Returns "login (full name)"

Returns:

"login (full name)"

getFullNameAndLogin

public java.lang.String getFullNameAndLogin()

Returns "full name (login)"

Returns:

"full name (login)"

getRights

public java.util.Set<java.lang.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(java.util.Set<java.lang.String> rights)

Sets rights.

Parameters:

rights -