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

Class Competition

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

@Entity(name="Competition")
public class Competition
extends Removed
implements Serializable

A competition

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Competition(String name, String abbreviation, String description, SportType sport, CompetitionType type, String contactPerson, String email, String web, String telephone, Boolean openToInscription, Boolean publicVisibility, Integer minTeams, Integer maxTeams, User admin) Creates a new instance Competition
Competition(String name, String abbreviation, String description, SportType sport, CompetitionType type, String contactPerson, String email, String web, String telephone, String facebook, String twitter, String instagram, Boolean openToInscription, Boolean publicVisibility, Integer minTeams, Integer maxTeams, User admin, List<Team> teams, List<Headquarter> headquarters, List<Team> competitors) Creates a new instance Competition

Method Summary

Modifier and Type	Method and Description
void	addHeadquarters(Headquarter headquarters) Adds a headquarters from this competition
void	addTeam(Team team) Adds a team to the Competition
void	changeOpenToInscription() Changes the inscription status of the Competition
void	changePublicVisibility() Changes the visibility of the Competition
String	getAbbreviation() Returns the abbreviation of the competition
User	getAdmin() Returns the admin of the competition
String	getContactPerson() Returns the name of the contact person
String	getDescription() Returns the description of the competition
String	getEmail() Returns the email of the competition
String	getFacebook() Returns the facebook account of the competition
Collection<Headquarter>	getHeadquarters() Returns the headquarters that belongs to this competitions.
int	getId() Returns identification of the competition
String	getInstagram() Returns the instagram account of the competition
Integer	getMaxTeams() Returns the maximum teams that participate in the competition
Integer	getMinTeams() Returns the minimum teams that participate in the competition
String	getName() Returns the name of the competition
Boolean	getOpenToInscription() Returns if the competition inscription is open
Boolean	getPublicVisibility() Returns if the competition is visible for everybody
SportType	getSport() Returns the sport type of the competition
List<Team>	getTeams() Returns the teams of the competition
String	getTelephone() Returns the web of the contact person
String	getTwitter() Return the twitter account of the competition
CompetitionType	getType() Returns the type of the competition
String	getWeb() Returns the web of the competition
boolean	ownsTeam(Team team) Check if the player belongs to this team
void	removeHeadquarters(Headquarter headquarters) Removes a headquarters from this competition and removes the competition from the headquarters
void	removeTeam(Team team) Removes a team to the Competition
void	setAbbreviation(String abbreviation) Sets the abbreviation of the competition
void	setAdmin(User admin) Sets the admin of the competition
void	setContactPerson(String contactPerson) Sets the contact person of the competition
void	setDescription(String description) Sets the description of the competition
void	setEmail(String email) Sets the email of the competition
void	setFacebook(String facebook) Sets the facebook account of the competition
void	setInstagram(String instagram) Sets the instagram account of the competition
void	setMaxTeams(Integer maxTeams) Sets the maximum of teams in the competition
void	setMinTeams(Integer minTeams) Sets the minimum of teams in the competition
void	setName(String name) Sets the name of the competition
void	setOpenToInscription(Boolean openToInscription) Sets the state of the inscriptions in the competition
void	setPublicVisibility(Boolean publicVisibility) Sets the visibility of the competition
void	setSport(SportType sport) Sets the sport of the competition
void	setTeams(List<Team> teams) Sets the teams of the competition
void	setTelephone(String telephone) Sets the telephone of the contact person
void	setTwitter(String twitter) Sets the twitter account of the competition
void	setType(CompetitionType type) Sets the type of the competition
void	setWeb(String web) Sets the web of the competition

Methods inherited from class es.uvigo.esei.dgss.teamb.ligaaas.domain.entities.Removed

isRemoved, setRemoved

Methods inherited from class java.lang.Object

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

Constructor Detail

Competition

public Competition(String name,
                   String abbreviation,
                   String description,
                   SportType sport,
                   CompetitionType type,
                   String contactPerson,
                   String email,
                   String web,
                   String telephone,
                   String facebook,
                   String twitter,
                   String instagram,
                   Boolean openToInscription,
                   Boolean publicVisibility,
                   Integer minTeams,
                   Integer maxTeams,
                   User admin,
                   List<Team> teams,
                   List<Headquarter> headquarters,
                   List<Team> competitors)

Creates a new instance Competition

Parameters:

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

abbreviation - shortcut identifier for the identification. Must be a non empty and non null string with a maximum length of 25 chars.

description - the description of a competition. Must be a non null string with a maximum length of 250 chars.

sport - is an enumerated data with all the possibles choices of our system in terms of competition sport. Must be a non empty and non null string.

type - is an enumerated data with all the possibles choices of our system in terms of competition type. Must be a non empty and non null string.

contactPerson - the person who manages the competition. Must be a non null string with a maximum length of 100 chars.

email - the email of the contact person. Must be a non null string with a maximum length of 100 chars.

web - the competition's website. Must be a non null string with a maximum length of 150 chars.

telephone - the phone of the contact person. Must be a non null string with a maximum length of 25 chars.

facebook - the facebook account of the competition

twitter - the twitter account of the competition

instagram - the instagram account of the competition

openToInscription - indication of whether it is open to registration or if it is a closed competition

minTeams - minimum number of competition teams. This number must be greater than 0.

maxTeams - maximum number of competition teams. This number must be greater than 0.

publicVisibility - competition visibility. True visible, false private

admin - the admin of the competition, Must be a non null

teams - the teams that belong to this competition

headquarters - the headquarters that belong to this competition

competitors - the competitors that belong to this competition

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.

Competition

public Competition(String name,
                   String abbreviation,
                   String description,
                   SportType sport,
                   CompetitionType type,
                   String contactPerson,
                   String email,
                   String web,
                   String telephone,
                   Boolean openToInscription,
                   Boolean publicVisibility,
                   Integer minTeams,
                   Integer maxTeams,
                   User admin)

Creates a new instance Competition

Parameters:

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

abbreviation - shortcut identifier for the identification. Must be a non empty and non null string with a maximum length of 25 chars.

description - the description of a competition. Must be a non null string with a maximum length of 250 chars.

sport - is an enumerated data with all the possibles choices of our system in terms of competition sport. Must be a non empty and non null string.

type - is an enumerated data with all the possibles choices of our system in terms of competition type. Must be a non empty and non null string.

contactPerson - the person who manages the competition. Must be a non null string with a maximum length of 100 chars.

email - the email of the contact person. Must be a non null string with a maximum length of 100 chars.

web - the competition's website. Must be a non null string with a maximum length of 150 chars.

telephone - the phone of the contact person. Must be a non null string with a maximum length of 25 chars.

openToInscription - indication of whether it is open to registration or if it is a closed competition

minTeams - minimum number of competition teams. This number must be greater than 0.

maxTeams - maximum number of competition teams. This number must be greater than 0.

publicVisibility - competition visibility. True visible, false private

admin - the admin of the competition. Must be a non null.

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

getId

public int getId()

Returns identification of the competition

Returns:

the identification of the competition

getName

public String getName()

Returns the name of the competition

Returns:

the name of the competition

setName

public void setName(String name)

Sets the name of the competition

Parameters:

name - the name of the competition. 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.

getAbbreviation

public String getAbbreviation()

Returns the abbreviation of the competition

Returns:

the abbreviation of the competition

setAbbreviation

public void setAbbreviation(String abbreviation)

Sets the abbreviation of the competition

Parameters:

abbreviation - the abbreviation of the competition. 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.

getTeams

public List<Team> getTeams()

Returns the teams of the competition

Returns:

the teams of the competition

setTeams

public void setTeams(List<Team> teams)

Sets the teams of the competition

Parameters:

teams - the teams of the competition. Must be a non empty and non null string.

Throws:

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

getDescription

public String getDescription()

Returns the description of the competition

Returns:

the description of the competition

setDescription

public void setDescription(String description)

Sets the description of the competition

Parameters:

description - the description of the competition. Must be a non null string with a maximum length of 250 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.

getContactPerson

public String getContactPerson()

Returns the name of the contact person

Returns:

the name of the contact person

setContactPerson

public void setContactPerson(String contactPerson)

Sets the contact person of the competition

Parameters:

contactPerson - the contact person of the competition. Must be a 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.

getEmail

public String getEmail()

Returns the email of the competition

Returns:

the email of the competition

setEmail

public void setEmail(String email)

Sets the email of the competition

Parameters:

email - the email of the competition. Must be a 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.

getWeb

public String getWeb()

Returns the web of the competition

Returns:

the web of the competition

setWeb

public void setWeb(String web)

Sets the web of the competition

Parameters:

web - the web of the competition. Must be a non null string with a maximum length of 150 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.

getTelephone

public String getTelephone()

Returns the web of the contact person

Returns:

the web of the contact person

setTelephone

public void setTelephone(String telephone)

Sets the telephone of the contact person

Parameters:

telephone - the telephone of the contact person. Must be a 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.

getFacebook

public String getFacebook()

Returns the facebook account of the competition

Returns:

the facebook account of the competition

setFacebook

public void setFacebook(String facebook)

Sets the facebook account of the competition

Parameters:

facebook - the new facebook account of the competition

getTwitter

public String getTwitter()

Return the twitter account of the competition

Returns:

the twitter account of the competition

setTwitter

public void setTwitter(String twitter)

Sets the twitter account of the competition

Parameters:

twitter - the new twitter account of the competition

getInstagram

public String getInstagram()

Returns the instagram account of the competition

Returns:

the instagram account of the competition

setInstagram

public void setInstagram(String instagram)

Sets the instagram account of the competition

Parameters:

instagram - the new instagram account of the competition

getOpenToInscription

public Boolean getOpenToInscription()

Returns if the competition inscription is open

Returns:

if the competition inscription is open

setOpenToInscription

public void setOpenToInscription(Boolean openToInscription)

Sets the state of the inscriptions in the competition

Parameters:

openToInscription - the state of the inscription in the competition (true=open, false=closed). Must be a non empty and non null Boolean.

Throws:

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

getPublicVisibility

public Boolean getPublicVisibility()

Returns if the competition is visible for everybody

Returns:

if the competition is visible for everybody

setPublicVisibility

public void setPublicVisibility(Boolean publicVisibility)

Sets the visibility of the competition

Parameters:

publicVisibility - the visibility of the competition (public=true, private=false). Must be a non empty and non null Boolean.

Throws:

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

getMinTeams

public Integer getMinTeams()

Returns the minimum teams that participate in the competition

Returns:

the minimum teams that participate in the competition

setMinTeams

public void setMinTeams(Integer minTeams)

Sets the minimum of teams in the competition

Parameters:

minTeams - the minimum of teams in the competition. Must be a positive and non null Integer.

Throws:

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

IllegalArgumentException - if a minTeams is a number less than 0

getMaxTeams

public Integer getMaxTeams()

Returns the maximum teams that participate in the competition

Returns:

if the maximum teams that participate in the competition

setMaxTeams

public void setMaxTeams(Integer maxTeams)

Sets the maximum of teams in the competition

Parameters:

maxTeams - the maximum of teams in the competition. Must be a positive and non null Integer.

Throws:

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

IllegalArgumentException - if a maxTeams is a number less than 0

getAdmin

public User getAdmin()

Returns the admin of the competition

Returns:

the admin of the competition

setAdmin

public void setAdmin(User admin)

Sets the admin of the competition

Parameters:

admin - the admin of the competition. Must be a non null User.

Throws:

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

getSport

public SportType getSport()

Returns the sport type of the competition

Returns:

the sport type of the competition

setSport

public void setSport(SportType sport)

Sets the sport of the competition

Parameters:

sport - is an enumerated data with all the possibles choices of our system in terms of competition sports. Must be a non empty and non null string.

Throws:

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

getType

public CompetitionType getType()

Returns the type of the competition

Returns:

the type of the competition

setType

public void setType(CompetitionType type)

Sets the type of the competition

Parameters:

type - is an enumerated data with all the possibles choices of our system in terms of competition type. Must be a non empty and non null string.

Throws:

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

changeOpenToInscription

public void changeOpenToInscription()

Changes the inscription status of the Competition

changePublicVisibility

public void changePublicVisibility()

Changes the visibility of the Competition

addTeam

public void addTeam(Team team)

Adds a team to the Competition

Parameters:

team - is a team instance. Must be a non null Team.

Throws:

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

IllegalArgumentException - if the team belongs to this competition or this competition is complete

removeTeam

public void removeTeam(Team team)

Removes a team to the Competition

Parameters:

team - is a team instance. Must be a non null Team.

Throws:

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

IllegalArgumentException - if the team does not belong to this competition

addHeadquarters

public void addHeadquarters(Headquarter headquarters)

Adds a headquarters from this competition

Parameters:

headquarters - the headquarters to add to this competition

Throws:

NullPointerException - if a headquarters is null.

removeHeadquarters

public void removeHeadquarters(Headquarter headquarters)

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

Parameters:

headquarters - the headquarters to remove to this competition

Throws:

NullPointerException - if a headquarters is null.

IllegalArgumentException - if the headquarters does not belong to this competition

getHeadquarters

public Collection<Headquarter> getHeadquarters()

Returns the headquarters that belongs to this competitions.

Returns:

the headquarters that belongs to this competitions

ownsTeam

public boolean ownsTeam(Team team)

Check if the player belongs to this team

Parameters:

team - the player whose property will be checked

Returns:

true if the player belongs to this team. false otherwise