es.uvigo.esei.dgss.teamB.ligaaas.domain.entities

Class User

java.lang.Object

es.uvigo.esei.dgss.teamB.ligaaas.domain.entities.User

All Implemented Interfaces:

Serializable

@Entity
public class User
extends Object
implements Serializable

A system user

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
User(String email, String name, String surname, GregorianCalendar birthdate, IdentificationType identificationType, String numIdentificationType, String residence, String location, String province, String country, String phone) Creates a new instance User
User(String email, String name, String surname, GregorianCalendar birthdate, IdentificationType identificationType, String numIdentificationType, String residence, String location, String province, String country, String phone, HashMap<String,String> socialNetworks, Player player, ArrayList<Player> managedPlayers, ArrayList<Competition> managedCompetitions, Team... teams) Creates a new instance User

Method Summary

Modifier and Type	Method and Description
void	addCompetition(Competition competition) Creates the relation between the user and the competition.
void	addPlayer(Player player) Creates the relation between the user and the player.
void	addTeam(Team team) Adds a team to this user
GregorianCalendar	getBirthdate() Returns the birthdate of the user
String	getCountry() Returns the country of the user
String	getEmail() Returns the email of the user
IdentificationType	getIdentificationType() Returns the identificationType of the user
String	getLocation() Returns the location of the user
ArrayList<Competition>	getManagedCompetitions() Returns the competitions managed by the user
ArrayList<Player>	getManagedPlayers() Returns the players managed by the user
String	getName() Returns the name of the user
String	getNumIdentificationType() Returns the user identification number
String	getPhone() Returns the phone of the user
Player	getPlayerUser()
String	getProvince() Returns the province of the user
String	getResidence() Returns the residence of the user
HashMap<String,String>	getSocialNetworks() Returns the social networks of the user
String	getSurname() Returns the surname of the user
Collection<Team>	getTeams() Returns the user that belongs to this user.
boolean	hasOwner(Team team) Checks if the team already has an owner
void	internalAddCompetition(Competition competition) Adds a competition directly to the competition list of this user if the competition does not already managed by this user.
void	internalAddPlayer(Player player) Sets the atribute player of the user
void	internalAddPlayerList(Player player) Adds a player directly to the player list of this user if the player does not already managed by this user.
void	internalAddTeam(Team team) Adds a team directly to the teams collection of this user if the team does not already belongs to this user
void	internalRemoveCompetition(Competition competition) Removes a competition directly from the competitions list of this user.
void	internalRemovePlayerList(Player player) Removes a player directly from the players list of this user.
void	internalRemoveTeam(Team team) Removes a team directly to this teams collection of this user if the team does not already belongs to this headquarters
boolean	managesCompetition(Competition competition) Checks if a competition is managed by the user.
boolean	managesPlayers(Player player) Checks if a player is managed by the user.
boolean	ownsTeam(Team team) Checks if a team belongs to this user
void	removeCompetition(Competition competition) Deletes the relation between the user and the competition.
void	removePlayer(Player player) Deletes the relation between the user and the player.
void	removeTeam(Team team) Removes a team from this user
void	setBirthdate(GregorianCalendar birthdate) Sets the birthdate of the user
void	setCountry(String country) Sets the country of the user
void	setEmail(String email) Sets the email of the user
void	setIdentificationType(IdentificationType identificationType) Sets the identification type of the user
void	setLocation(String location) Sets the location of the user
void	setManagedCompetitions(ArrayList<Competition> managedCompetitions) Sets the competitions managed by the user
void	setManagedPlayers(ArrayList<Player> managedPlayers) Sets the players managed by the user
void	setName(String name) Sets the name of the user
void	setNumIdentificationType(String numIdentificationType) Sets the user identification number
void	setPhone(String phone) Sets the phone of the user
void	setPlayerUser(Player userPlayer)
void	setProvince(String province) Sets the province of the user
void	setResidence(String residence) Sets the residence of the user
void	setSocialNetworks(HashMap<String,String> socialNetworks) Sets the social networks of the user
void	setSurname(String surname) Sets the name of the user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

User

public User(String email,
            String name,
            String surname,
            GregorianCalendar birthdate,
            IdentificationType identificationType,
            String numIdentificationType,
            String residence,
            String location,
            String province,
            String country,
            String phone,
            HashMap<String,String> socialNetworks,
            Player player,
            ArrayList<Player> managedPlayers,
            ArrayList<Competition> managedCompetitions,
            Team... teams)

Creates a new instance User

Parameters:

email - the email of the user which identifies the user in the system. Must be a non empty and non null string with a maximum length of 100 chars.

name - the name of the user. Must be a non empty and non null string with a maximum length of 100 chars.

surname - the surname of the user. Must be a non empty and non null string with a maximum length of 200 chars.

birthdate - the birthdate of the user. Must be a non empty and non null string.

identificationType - the enumerated data with all the possibles choices of the system in identification type of user. Must be a non empty and non null string.

numIdentificationType - the user identification number in the format of the identificationType. Must be a non empty and non null string with a maximum length of 50 chars.

residence - the residence of the user. Must be a non empty and non null string with a maximum length of 200 chars.

location - the location of the user. Must be a non empty and non null string with a maximum length of 100 chars.

province - the province of the user. Must be a non empty and non null string with a maximum length of 100 chars.

country - the country of the user. Must be a non empty and non null string with a maximum length of 100 chars.

phone - the phone of the user. Must be a non empty and non null string with a maximum length of 25 chars.

socialNetworks - the map of the social networks of the user, with the value of the social network as a key and the profile in that social network as a value.

player - the player atribute of the user witch represent a player who has an user account.

managedPlayers - the player list managed by the user.

managedCompetitions - the competitions managed by the user.Must be a non empty and non null list of competitions.

teams - the teams managed by the user.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

User

public User(String email,
            String name,
            String surname,
            GregorianCalendar birthdate,
            IdentificationType identificationType,
            String numIdentificationType,
            String residence,
            String location,
            String province,
            String country,
            String phone)

Creates a new instance User

Parameters:

email - the email of the user which identifies the user in the system. Must be a non empty and non null string with a maximum length of 100 chars.

name - the name of the user. Must be a non empty and non null string with a maximum length of 100 chars.

surname - the surname of the user. Must be a non empty and non null string with a maximum length of 200 chars.

birthdate - the birthdate of the user. Must be a non empty and non null string.

identificationType - the enumerated data with all the possibles choices of the system in identification type of user. Must be a non empty and non null string.

numIdentificationType - the user identification number in the format of the identificationType. Must be a non empty and non null string with a maximum length of 50 chars.

residence - the residence of the user. Must be a non empty and non null string with a maximum length of 200 chars.

location - the location of the user. Must be a non empty and non null string with a maximum length of 100 chars.

province - the province of the user. Must be a non empty and non null string with a maximum length of 100 chars.

country - the country of the user. Must be a non empty and non null string with a maximum length of 100 chars.

phone - the phone of the user. Must be a non empty and non null string with a maximum length of 25 chars.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

Method Detail

getEmail

public String getEmail()

Returns the email of the user

Returns:

the email

setEmail

public void setEmail(String email)

Sets the email of the user

Parameters:

email - the email of the user which identifies the user in the system. Must be a non empty and non null string with a maximum length of 100 chars.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

getName

public String getName()

Returns the name of the user

Returns:

the name

setName

public void setName(String name)

Sets the name of the user

Parameters:

name - the name of the user. Must be a non empty and non null string with a maximum length of 100 chars.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

getSurname

public String getSurname()

Returns the surname of the user

Returns:

the surname

setSurname

public void setSurname(String surname)

Sets the name of the user

Parameters:

surname - the surname of the user. Must be a non empty and non null string with a maximum length of 200 chars.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

getBirthdate

public GregorianCalendar getBirthdate()

Returns the birthdate of the user

Returns:

the birthdate

setBirthdate

public void setBirthdate(GregorianCalendar birthdate)

Sets the birthdate of the user

Parameters:

birthdate - the birthdate of the user. Must be a non empty and non null string.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

getIdentificationType

public IdentificationType getIdentificationType()

Returns the identificationType of the user

Returns:

the identificationType

setIdentificationType

public void setIdentificationType(IdentificationType identificationType)

Sets the identification type of the user

Parameters:

identificationType - the enumerated data with all the possibles choices of the system in identification type of user. Must be a non empty and non null string.

Throws:

NullPointerException - if a null value is passed as the value for any parameter..

getNumIdentificationType

public String getNumIdentificationType()

Returns the user identification number

Returns:

the numIdentificationType

setNumIdentificationType

public void setNumIdentificationType(String numIdentificationType)

Sets the user identification number

Parameters:

numIdentificationType - the user identification number in the format of the identificationType. Must be a non empty and non null string with a maximum length of 50 chars.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

getResidence

public String getResidence()

Returns the residence of the user

Returns:

the residence

setResidence

public void setResidence(String residence)

Sets the residence of the user

Parameters:

residence - the residence of the user. Must be a non empty and non null string with a maximum length of 200 chars.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

getLocation

public String getLocation()

Returns the location of the user

Returns:

the location

setLocation

public void setLocation(String location)

Sets the location of the user

Parameters:

location - the location of the user. Must be a non empty and non null string with a maximum length of 100 chars.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

getProvince

public String getProvince()

Returns the province of the user

Returns:

the province

setProvince

public void setProvince(String province)

Sets the province of the user

Parameters:

province - the province of the user. Must be a non empty and non null string with a maximum length of 100 chars.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

getCountry

public String getCountry()

Returns the country of the user

Returns:

the country

setCountry

public void setCountry(String country)

Sets the country of the user

Parameters:

country - the country of the user. Must be a non empty and non null string with a maximum length of 100 chars.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

getPhone

public String getPhone()

Returns the phone of the user

Returns:

the phone

setPhone

public void setPhone(String phone)

Sets the phone of the user

Parameters:

phone - the phone of the user. Must be a non empty and non null string with a maximum length of 25 chars.

Throws:

NullPointerException - if a null value is passed as the value for any parameter.

IllegalArgumentException - if value provided for any parameter is not valid according to its description.

getSocialNetworks

public HashMap<String,String> getSocialNetworks()

Returns the social networks of the user

Returns:

the socialNetworks

setSocialNetworks

public void setSocialNetworks(HashMap<String,String> socialNetworks)

Sets the social networks of the user

Parameters:

socialNetworks - the map of the social networks of the user, with the value of the social network as a key and the profile in that social network as a value.

getPlayerUser

public Player getPlayerUser()

Returns:

the userPlayer

setPlayerUser

public void setPlayerUser(Player userPlayer)

Parameters:

userPlayer - the userPlayer to set

internalAddPlayer

public void internalAddPlayer(Player player)

Sets the atribute player of the user

Parameters:

player - Object type Player, witch represent a player who has an user account.

getTeams

public Collection<Team> getTeams()

Returns the user that belongs to this user. The collection returned unmodifiable and no order are guaranteed.

Returns:

the teams that belongs to this user

ownsTeam

public boolean ownsTeam(Team team)

Checks if a team belongs to this user

Parameters:

team - the team whose property will be checked

Returns:

true if the team belongs to this user. false otherwise

hasOwner

public boolean hasOwner(Team team)

Checks if the team already has an owner

Parameters:

team - the team whose property will be checked

Returns:

true if the team does not have a manager. false otherwise

addTeam

public void addTeam(Team team)

Adds a team to this user

Parameters:

team - the user to add to this user

Throws:

NullPointerException - if a team is null.

removeTeam

public void removeTeam(Team team)

Removes a team from this user

Parameters:

team - the user to remove to this user

Throws:

NullPointerException - if a team is null.

internalRemoveTeam

public void internalRemoveTeam(Team team)

Removes a team directly to this teams collection of this user if the team does not already belongs to this headquarters

Parameters:

team - the the to remove to this user

Throws:

NullPointerException - if a team is null.

internalAddTeam

public void internalAddTeam(Team team)

Adds a team directly to the teams collection of this user if the team does not already belongs to this user

Parameters:

team - the team to add to this user

Throws:

NullPointerException - if a team is null.

getManagedCompetitions

public ArrayList<Competition> getManagedCompetitions()

Returns the competitions managed by the user

Returns:

the managedCompetitions

setManagedCompetitions

public void setManagedCompetitions(ArrayList<Competition> managedCompetitions)

Sets the competitions managed by the user

Parameters:

managedCompetitions - the managedCompetitions to set

managesCompetition

public boolean managesCompetition(Competition competition)

Checks if a competition is managed by the user.

Parameters:

competition - the competition whose property will be checked.

Returns:

true if the competition is managed by the user. false otherwise.

internalRemoveCompetition

public void internalRemoveCompetition(Competition competition)

Removes a competition directly from the competitions list of this user. The competition's admin will not be updated.

Parameters:

competition - the competition to remove from this user. null values not supported.

Throws:

NullPointerException - if the competition is null.

internalAddCompetition

public void internalAddCompetition(Competition competition)

Adds a competition directly to the competition list of this user if the competition does not already managed by this user. The competition's admin will not be updated.

Parameters:

competition - the competition to add to this user. null values not supported.

Throws:

NullPointerException - if the competition is null.

addCompetition

public void addCompetition(Competition competition)

Creates the relation between the user and the competition.

Parameters:

competition - the competition to add to this user. null values not supported.

Throws:

NullPointerException - if the competition is null.

removeCompetition

public void removeCompetition(Competition competition)

Deletes the relation between the user and the competition.

Parameters:

competition - the competition to add to this user. null values not supported.

Throws:

NullPointerException - if the competition is null.

getManagedPlayers

public ArrayList<Player> getManagedPlayers()

Returns the players managed by the user

Returns:

the managedPlayers

setManagedPlayers

public void setManagedPlayers(ArrayList<Player> managedPlayers)

Sets the players managed by the user

Parameters:

managedPlayers - the managedPlayers to set

managesPlayers

public boolean managesPlayers(Player player)

Checks if a player is managed by the user.

Parameters:

player - the player whose property will be checked.

Returns:

true if the player is managed by the user. false otherwise.

internalRemovePlayerList

public void internalRemovePlayerList(Player player)

Removes a player directly from the players list of this user. The player's admin will not be updated.

Parameters:

player - the player to remove from this user. null values not supported.

Throws:

NullPointerException - if the player is null.

internalAddPlayerList

public void internalAddPlayerList(Player player)

Adds a player directly to the player list of this user if the player does not already managed by this user. The player's admin will not be updated.

Parameters:

player - the player to add to this user. null values not supported.

Throws:

NullPointerException - if the player is null.

addPlayer

public void addPlayer(Player player)

Creates the relation between the user and the player.

Parameters:

player - the player to add to this user. null values not supported.

Throws:

NullPointerException - if the player is null.

removePlayer

public void removePlayer(Player player)

Deletes the relation between the user and the player.

Parameters:

player - the player to add to this user. null values not supported.

Throws:

NullPointerException - if the player is null.