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

Class Headquarter

java.lang.Object

es.uvigo.esei.dgss.teamb.ligaaas.domain.entities.Headquarter

All Implemented Interfaces:

Serializable

@Entity(name="Headquarter")
public class Headquarter
extends Object
implements Serializable

A headquarter

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Headquarter(String name, String description, String address, String locality, String province, User admin) Creates a new instance of Headquarter.
Headquarter(String name, String description, String address, String locality, String province, User admin, Team... teams) Creates a new instance of Headquarter.

Method Summary

Modifier and Type	Method and Description
void	addCompetition(Competition competition) Adds a competition from this headquarters
void	addTeam(Team team) Adds a team to this headquarters
String	getAddress() Returns the address of the headquarter.
User	getAdmin() Returns the administrator of the headquarter.
Collection<Competition>	getCompetitions() Returns the competitions that belongs to this headquarters.
String	getDescription() Returns the description of the headquarter.
String	getLocality() Returns the locality of the headquarter.
String	getName() Returns the name of the headquarter.
String	getProvince() Returns the province of the headquarter.
Collection<Team>	getTeams() Returns the teams that belongs to this headquarters.
boolean	ownsTeam(Team team) Checks if a team belongs to this headquarters
void	removeCompetition(Competition competition) Removes a competition from this headquarters and removes this headquarters from the competition.
void	removeTeam(Team team) Removes a team from this headquarters
void	setAddress(String address) Sets the address of this headquarter.
void	setAdmin(User admin) Sets the administrator of this headquarter.
void	setCompetitions(ArrayList<Competition> competitions) Adds a list of competitions to the headquarters
void	setDescription(String description) Sets the description of this headquarter.
void	setLocality(String locality) Sets the locality of this headquarter.
void	setName(String name) Sets the name of this headquarter.
void	setProvince(String province) Sets the province of this headquarter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Headquarter

public Headquarter(String name,
                   String description,
                   String address,
                   String locality,
                   String province,
                   User admin)

Creates a new instance of Headquarter.

Parameters:

name - the name of the headquarter. This parameter must be a non empty and non null string with a maximum length of 100 chars.

description - the description of the headquarter. This parameter can not be null. String with a maximum length of 250 chars.

address - the address of this headquarter. This parameter can not be null. String with a maximum length of 100 chars.

locality - the locality of this headquarter. This parameter can not be null. String with a maximum length of 100 chars.

province - the province of this headquarter. This parameter can not be null. String with a maximum length of 100 chars.

admin - the administrator of this headquarter. A user class.

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.

Headquarter

public Headquarter(String name,
                   String description,
                   String address,
                   String locality,
                   String province,
                   User admin,
                   Team... teams)

Creates a new instance of Headquarter.

Parameters:

name - the name of the headquarter. This parameter must be a non empty and non null string with a maximum length of 100 chars.

description - the description of the headquarter. This parameter can not be null. String with a maximum length of 250 chars.

address - the address of this headquarter. This parameter can not be null. String with a maximum length of 100 chars.

locality - the locality of this headquarter. This parameter can not be null. String with a maximum length of 100 chars.

province - the province of this headquarter. This parameter can not be null. String with a maximum length of 100 chars.

admin - the administrator of this headquarter. A user class.

teams - the teams to belongs this headquarters

Method Detail

getName

public String getName()

Returns the name of the headquarter.

Returns:

the name of the headquarter.

setName

public void setName(String name)

Sets the name of this headquarter.

Parameters:

name - the new name of this headquarter. This parameter can not be null and can not be longer than 100 chars.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the value provided is longer than 100 chars.

getDescription

public String getDescription()

Returns the description of the headquarter.

Returns:

the description of the headquarter.

setDescription

public void setDescription(String description)

Sets the description of this headquarter.

Parameters:

description - is the new description for this headquarter. This parameter can not be null and can not be longer than 250 chars.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the value provided is longer than 250 chars.

getAddress

public String getAddress()

Returns the address of the headquarter.

Returns:

the address of the headquarter.

setAddress

public void setAddress(String address)

Sets the address of this headquarter.

Parameters:

address - is the new address for this headquarter. This parameter can not be null and can not be longer than 100 chars.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the value provided is longer than 100 chars.

getLocality

public String getLocality()

Returns the locality of the headquarter.

Returns:

the locality of the headquarter.

setLocality

public void setLocality(String locality)

Sets the locality of this headquarter.

Parameters:

locality - is the new locality for this headquarter. This parameter can not be null and can not be longer than 100 chars.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the value provided is longer than 100 chars.

getProvince

public String getProvince()

Returns the province of the headquarter.

Returns:

the province of the headquarter.

setProvince

public void setProvince(String province)

Sets the province of this headquarter.

Parameters:

province - is the new province for this headquarter. This parameter can not be null and can not be longer than 100 chars.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the value provided is longer than 100 chars.

getAdmin

public User getAdmin()

Returns the administrator of the headquarter.

Returns:

the administrator of the headquarter.

setAdmin

public void setAdmin(User admin)

Sets the administrator of this headquarter.

Parameters:

admin - is the new administrator for this headquarter. This parameter can not be null.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the value provided is not a User.

getTeams

public Collection<Team> getTeams()

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

Returns:

the teams that belongs to this headquarters

addTeam

public void addTeam(Team team)

Adds a team to this headquarters

Parameters:

team - the team to add to this headquarters

Throws:

NullPointerException - if a team is null.

removeTeam

public void removeTeam(Team team)

Removes a team from this headquarters

Parameters:

team - the team to remove to this headquarters

Throws:

NullPointerException - if a team is null.

IllegalArgumentException - if the team does not belong to this headquarters

ownsTeam

public boolean ownsTeam(Team team)

Checks if a team belongs to this headquarters

Parameters:

team - the team whose property will be checked

Returns:

true if the team belongs to this headquarters. false otherwise

addCompetition

public void addCompetition(Competition competition)

Adds a competition from this headquarters

Parameters:

competition - the competition to add to this headquarters

Throws:

NullPointerException - if a null value is passed.

removeCompetition

public void removeCompetition(Competition competition)

Removes a competition from this headquarters and removes this headquarters from the competition.

Parameters:

competition - the competition to remove to this headquarters

Throws:

NullPointerException - if a competition is null.

IllegalArgumentException - if the competition does not belong to this headquarters

getCompetitions

public Collection<Competition> getCompetitions()

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

Returns:

the competitions that belongs to this headquarters

setCompetitions

public void setCompetitions(ArrayList<Competition> competitions)

Adds a list of competitions to the headquarters

Parameters:

competitions - the list to add to the headquarters