Competition (Domain 0.1.0-SNAPSHOT API)

java.lang.Object
- ligaaas.teamc.domain.Competition

@Entity
public class Competition
extends Object

A Competition

Author:: teamC

Constructor Summary

Constructors
Constructor and Description
`Competition()` Creates a new empty instance of `Competition`.
`Competition(long competitionId, String competitionName, String competitionShortName, String competitionDescription, SportType competitionSportType, CompetitionType competitionType, Boolean competitionOpen, int competitionMinTeams, int competitionMaxTeams, Boolean competitionPublic, Boolean competitionDeleted, HeadQuarter competitionHeadQuarter, User competitionUser, Contact competitionContact)` Creates a new instance of `Competition`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Returns if two classes are equals
`Contact`	`getCompetitionContact()` Returns the competition `Contact`.
`Boolean`	`getCompetitionDeleted()` Returns if the competition is logically deleted.
`String`	`getCompetitionDescription()` Returns the description of the competition.
`HeadQuarter`	`getCompetitionHeadQuarter()` Returns the competition `HeadQuarter`.
`long`	`getCompetitionId()` Returns the id of the competition.
`int`	`getCompetitionMaxTeams()` Returns the max number of teams of the competition.
`int`	`getCompetitionMinTeams()` Returns the min number of teams of the competition.
`String`	`getCompetitionName()` Returns the name of the competition.
`Boolean`	`getCompetitionOpen()` Returns if the competition is open.
`Boolean`	`getCompetitionPublic()` Returns if the competition is public.
`String`	`getCompetitionShortName()` Returns the short name of the competition.
`SportType`	`getCompetitionSportType()` Returns the sport type of the competition.
`List<Team>`	`getCompetitionTeams()` Returns the competition `Team`s.
`CompetitionType`	`getCompetitionType()` Returns the competition type.
`User`	`getCompetitionUser()` Returns the competition `User`.
`int`	`hashCode()` Returns the hascCode of the competition.
`void`	`setCompetitionContact(Contact competitionContact)` Sets the competition `Contact`.
`void`	`setCompetitionDeleted(Boolean competitionDeleted)` Sets if competition is deleted.
`void`	`setCompetitionDescription(String competitionDescription)` Sets the description of the competition.
`void`	`setCompetitionHeadQuarter(HeadQuarter competitionHeadQuarter)` Sets the competition `HeadQuarter`.
`void`	`setCompetitionId(long competitionId)` Sets the id of the competition.
`void`	`setCompetitionMaxTeams(int competitionMaxTeams)` Sets the max number of teams of the competition.
`void`	`setCompetitionMinTeams(int competitionMinTeams)` Sets the min number of teams of the competition.
`void`	`setCompetitionName(String competitionName)` Sets the name of the competition.
`void`	`setCompetitionOpen(Boolean competitionOpen)` Sets if competition is open.
`void`	`setCompetitionPublic(Boolean competitionPublic)` Sets if competition is public.
`void`	`setCompetitionShortName(String competitionShortName)` Sets the short name of the competition.
`void`	`setCompetitionSportType(SportType competitionSportType)` Sets the description of the competition.
`void`	`setCompetitionTeams(List<Team> competitionTeams)` Sets the teams of the competition.
`void`	`setCompetitionType(CompetitionType competitionType)` Sets the type of the competition.
`void`	`setCompetitionUser(User competitionUser)` Sets the competition `User`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Competition
```
public Competition(long competitionId,
                   String competitionName,
                   String competitionShortName,
                   String competitionDescription,
                   SportType competitionSportType,
                   CompetitionType competitionType,
                   Boolean competitionOpen,
                   int competitionMinTeams,
                   int competitionMaxTeams,
                   Boolean competitionPublic,
                   Boolean competitionDeleted,
                   HeadQuarter competitionHeadQuarter,
                   User competitionUser,
                   Contact competitionContact)
```
    Creates a new instance of Competition.
    
    Parameters:
    
    competitionId - the id of the competition. This parameter must be a non empty and non null long .
    
    competitionName - the name of the competition. This parameter must be a non empty and non null String.
    
    competitionShortName - the short name of the competition. This parameter must be a non empty and non null String.
    
    competitionDescription - the description of the competition
    
    competitionSportType - the sport type of the competition. This parameter must be a non empty and non null SportType.
    
    competitionType - the type of the competition. This parameter must be a non empty and non null CompetitonType.
    
    competitionOpen - if the competition is open. This parameter must be a non null Boolean.
    
    competitionMinTeams - the min number of teams of the competition. This parameter must be a non empty and non null int.
    
    competitionMaxTeams - the max number of teams of the competition. This parameter must be a non empty and non null int.
    
    competitionPublic - if the competition is public. This parameter must be a non empty and non null boolean.
    
    competitionDeleted - if the competition is logicaly deleted. This parameter must be a non null boolean.
    
    competitionHeadQuarter - the Head Quarter of the competition. This parameter must be a HeadQuarter
    
    competitionUser - the User of the competition. This parameter must be a User
    
    competitionContact - the Contact of the competition. This parameter must be a Contact
    
    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()
```
    Creates a new empty instance of Competition.
- Method Detail
  - getCompetitionId
```
public long getCompetitionId()
```
    Returns the id of the competition.
    
    Returns:
    
    the id of the competition.
  - setCompetitionId
```
public void setCompetitionId(long competitionId)
```
    Sets the id of the competition.
    
    Parameters:
    
    competitionId - the id of the competition. This parameter must be a non empty and non null long.
  - getCompetitionName
```
public String getCompetitionName()
```
    Returns the name of the competition.
    
    Returns:
    
    the name of the competition.
  - setCompetitionName
```
public void setCompetitionName(String competitionName)
```
    Sets the name of the competition.
    
    Parameters:
    
    competitionName - the name of the competition. This parameter must be a non empty and non null string with a maximun length of 60 chars and a minumun length of 10 chars.
    
    Throws:
    
    NullPointerException - if a null value is passed.
    
    IllegalArgumentException - if the length of the string passed is not valid.
  - getCompetitionShortName
```
public String getCompetitionShortName()
```
    Returns the short name of the competition.
    
    Returns:
    
    the short name of the competition.
  - setCompetitionShortName
```
public void setCompetitionShortName(String competitionShortName)
```
    Sets the short name of the competition.
    
    Parameters:
    
    competitionShortName - the short name of the competition. This parameter must be a non empty and non null string with a maximun length of 10 chars and a minumun length of 2 chars.
    
    Throws:
    
    NullPointerException - if a null value is passed.
    
    IllegalArgumentException - if the length of the string passed is not valid.
  - getCompetitionDescription
```
public String getCompetitionDescription()
```
    Returns the description of the competition.
    
    Returns:
    
    the description of the competition.
  - setCompetitionDescription
```
public void setCompetitionDescription(String competitionDescription)
```
    Sets the description of the competition.
    
    Parameters:
    
    competitionDescription - the description of the competition. This parameter must be a non empty string with a maximun length of 240 chars and a minimun length of 10 chars.
    
    Throws:
    
    NullPointerException - if a null value is passed.
    
    IllegalArgumentException - if the length of the string passed is not valid.
  - getCompetitionSportType
```
public SportType getCompetitionSportType()
```
    Returns the sport type of the competition.
    
    Returns:
    
    the sport type of the competition.
  - setCompetitionSportType
```
public void setCompetitionSportType(SportType competitionSportType)
```
    Sets the description of the competition.
    
    Parameters:
    
    competitionSportType - the description of the competition. This parameter must be a non empty and non null SportType.
    
    Throws:
    
    NullPointerException - if a null value is passed.
    
    IllegalArgumentException - if the length of the string passed is not valid.
  - getCompetitionOpen
```
public Boolean getCompetitionOpen()
```
    Returns if the competition is open.
    
    Returns:
    
    if the competition is open.
  - setCompetitionOpen
```
public void setCompetitionOpen(Boolean competitionOpen)
```
    Sets if competition is open.
    
    Parameters:
    
    competitionOpen - if competition is open. This parameter must be a non empty and non null boolean.
    
    Throws:
    
    NullPointerException - if a null value is passed.
  - getCompetitionMinTeams
```
public int getCompetitionMinTeams()
```
    Returns the min number of teams of the competition.
    
    Returns:
    
    the min number of teams of the competition.
  - setCompetitionMinTeams
```
public void setCompetitionMinTeams(int competitionMinTeams)
```
    Sets the min number of teams of the competition.
    
    Parameters:
    
    competitionMinTeams - min number of teams of the competition. This parameter must be a non empty and non null int greater than 0.
    
    Throws:
    
    NullPointerException - if a null value is passed.
    
    IllegalArgumentException - if the value is zero or less.
  - getCompetitionMaxTeams
```
public int getCompetitionMaxTeams()
```
    Returns the max number of teams of the competition.
    
    Returns:
    
    the max number of teams of the competition.
  - setCompetitionMaxTeams
```
public void setCompetitionMaxTeams(int competitionMaxTeams)
```
    Sets the max number of teams of the competition.
    
    Parameters:
    
    competitionMaxTeams - max number of teams of the competition. This parameter must be a non empty and non null int greater than 0.
    
    Throws:
    
    NullPointerException - if a null value is passed.
    
    IllegalArgumentException - if the value is zero or less.
  - getCompetitionPublic
```
public Boolean getCompetitionPublic()
```
    Returns if the competition is public.
    
    Returns:
    
    if the competition is public.
  - setCompetitionPublic
```
public void setCompetitionPublic(Boolean competitionPublic)
```
    Sets if competition is public.
    
    Parameters:
    
    competitionPublic - if competition is public. This parameter must be a non empty and non null boolean.
    
    Throws:
    
    NullPointerException - if a null value is passed.
  - getCompetitionDeleted
```
public Boolean getCompetitionDeleted()
```
    Returns if the competition is logically deleted.
    
    Returns:
    
    if the competition is logically deleted.
  - setCompetitionDeleted
```
public void setCompetitionDeleted(Boolean competitionDeleted)
```
    Sets if competition is deleted.
    
    Parameters:
    
    competitionDeleted - if competition is deleted. This parameter must be a non empty and non null boolean.
    
    Throws:
    
    NullPointerException - if a null value is passed.
  - getCompetitionHeadQuarter
```
public HeadQuarter getCompetitionHeadQuarter()
```
    Returns the competition HeadQuarter.
    
    Returns:
    
    the competition HeadQuarter.
  - setCompetitionHeadQuarter
```
public void setCompetitionHeadQuarter(HeadQuarter competitionHeadQuarter)
```
    Sets the competition HeadQuarter.
    
    Parameters:
    
    competitionHeadQuarter - the Head quarter of the competition. This parameter must be a HeadQuarter.
  - getCompetitionUser
```
public User getCompetitionUser()
```
    Returns the competition User.
    
    Returns:
    
    the competition User.
  - setCompetitionUser
```
public void setCompetitionUser(User competitionUser)
```
    Sets the competition User.
    
    Parameters:
    
    competitionUser - the User of the competition. This parameter must be a User.
  - getCompetitionContact
```
public Contact getCompetitionContact()
```
    Returns the competition Contact.
    
    Returns:
    
    the competition Contact.
  - setCompetitionContact
```
public void setCompetitionContact(Contact competitionContact)
```
    Sets the competition Contact.
    
    Parameters:
    
    competitionContact - the contact of the competition. This parameter must be a Contact.
  - getCompetitionType
```
public CompetitionType getCompetitionType()
```
    Returns the competition type.
    
    Returns:
    
    the competition type.
  - setCompetitionType
```
public void setCompetitionType(CompetitionType competitionType)
```
    Sets the type of the competition.
    
    Parameters:
    
    competitionType - the sport type of the competition. This parameter must be a non empty and non null CompetitionType .
    
    Throws:
    
    NullPointerException - if a null value is passed.
  - getCompetitionTeams
```
public List<Team> getCompetitionTeams()
```
    Returns the competition Teams.
    
    Returns:
    
    the competition Teams.
  - setCompetitionTeams
```
public void setCompetitionTeams(List<Team> competitionTeams)
```
    Sets the teams of the competition.
    
    Parameters:
    
    competitionTeams - List of Teams that participates in a competition. This parameter must be a non null List of Team
    
    Throws:
    
    NullPointerException - if a null value is passed.
  - hashCode
```
public int hashCode()
```
    Returns the hascCode of the competition.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the hashCode of the competition.
  - equals
```
public boolean equals(Object obj)
```
    Returns if two classes are equals
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - the object to compare
    
    Returns:
    
    if object and this are equals.

Class Competition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Competition

Competition

Method Detail

getCompetitionId

setCompetitionId

getCompetitionName

setCompetitionName

getCompetitionShortName

setCompetitionShortName

getCompetitionDescription

setCompetitionDescription

getCompetitionSportType

setCompetitionSportType

getCompetitionOpen

setCompetitionOpen

getCompetitionMinTeams

setCompetitionMinTeams

getCompetitionMaxTeams

setCompetitionMaxTeams

getCompetitionPublic

setCompetitionPublic

getCompetitionDeleted

setCompetitionDeleted

getCompetitionHeadQuarter

setCompetitionHeadQuarter

getCompetitionUser

setCompetitionUser

getCompetitionContact

setCompetitionContact

getCompetitionType

setCompetitionType

getCompetitionTeams

setCompetitionTeams

hashCode

equals