Event (Domain 0.2.0-SNAPSHOT API)

java.lang.Object
- es.uvigo.esei.dgss.lettab.domain.Event

All Implemented Interfaces:

Serializable
```
@Entity
public class Event
extends Object
implements Serializable
```
Entity to persist the Events This entity represents an event in the application

Author:

ansousa,ansaa

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Event.Category` Enum representing all the availables types of the events: music, literature, sports, tv, cinema, internet, travel, theater

Constructor Summary

Constructors
Constructor and Description
`Event()` Constructor a new instance of `Event`.
`Event(Integer id, String title, Event.Category category, String description, String longDescription, Date eventDate, String location, int participants, long duration, User creator)` Constructs a new instance of `Event`.
`Event(String title, Event.Category category, String description, String longDescription, Date eventDate, String location, long duration, User creator)` Constructs a new instance of `Event`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCreator(User creator)` Adds a creator to an event
`void`	`addParticipant(User participant)` Adds a participant to an event and increase the participants number for that event
`Event.Category`	`getCategory()` Returns the category of the event
`User`	`getCreator()` Returns the owner of the event
`String`	`getDescription()` Returns the description of the event.
`long`	`getDuration()` Returns the duration of the event
`Date`	`getEventDate()` Returns event date.
`int`	`getId()` Return the identifier of the event
`String`	`getLocation()` Returns the location of the event
`String`	`getLongDescription()` Returns the long description of the event
`int`	`getParticipants()` Returns the participants of the event
`List<User>`	`getParticipantsList()` Returns the list of event participants
`String`	`getTitle()` Return the event's title
`void`	`setCategory(Event.Category category)` Sets the category of the event
`void`	`setCreator(User creator)` Sets the owner of the event
`void`	`setDescription(String description)` Sets the description of the event
`void`	`setDuration(long duration)` Sets the duration of the event
`void`	`setEventDate(Date eventDate)` Sets the event date
`void`	`setId(int id)`
`void`	`setLocation(String location)` Sets the location of the event
`void`	`setLongDescription(String longDescription)` Sets the long description of the event
`void`	`setParticipants(int participants)` Sets the participants of the event
`void`	`setTitle(String title)` Sets the title of the event

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

- Constructor Detail
  - Event
```
public Event()
```
    Constructor a new instance of Event. This constructor is empty because is required
  - Event
```
public Event(Integer id,
             String title,
             Event.Category category,
             String description,
             String longDescription,
             Date eventDate,
             String location,
             int participants,
             long duration,
             User creator)
```
    Constructs a new instance of Event. This constructor is necessary and only used for the realization of the datasets.
    
    Parameters:
    
    id - id for event
    
    title - The title of the events. It must be non-null, non-empty and no greater than 20 characters.
    
    category - The category of the event. It cannot be null.
    
    description - The description of the event. It must be non-null, non-empty and no greater than 50 characters.
    
    longDescription - The long description of the event. It must be non-null, non-empty and no greater than 255 characters.
    
    eventDate - The date of the event
    
    location - The location of the event
    
    participants - number of participants for the event
    
    duration - The duration of the event
    
    creator - The owner of the event
  - Event
```
public Event(String title,
             Event.Category category,
             String description,
             String longDescription,
             Date eventDate,
             String location,
             long duration,
             User creator)
```
    Constructs a new instance of Event. Creates a new event with an author
    
    Parameters:
    
    title - The title of the events. It must be non-null, non-empty and no greater than 20 characters.
    
    category - The category of the event. It cannot be null.
    
    description - The description of the event. It must be non-null, non-empty and no greater than 50 characters.
    
    longDescription - The long description of the event. It must be non-null, non-empty and no greater than 255 characters.
    
    eventDate - The date of the event
    
    location - The location of the event
    
    duration - The duration of the event
    
    creator - The owner of the event
- Method Detail
  - getId
```
public int getId()
```
    Return the identifier of the event
    
    Returns:
    
    the identifier of the event
  - setId
```
public void setId(int id)
```
  - getTitle
```
public String getTitle()
```
    Return the event's title
    
    Returns:
    
    the title of the event
  - setTitle
```
public void setTitle(String title)
```
    Sets the title of the event
    
    Parameters:
    
    title - The new event's title.
    
    Throws:
    
    IllegalArgumentException - If the title is 20 characters long or less than 1 character
  - getDuration
```
public long getDuration()
```
    Returns the duration of the event
    
    Returns:
    
    the duration of the event
  - setDuration
```
public void setDuration(long duration)
```
    Sets the duration of the event
    
    Parameters:
    
    duration - The new event's duration.
    
    Throws:
    
    IllegalArgumentException - If the duration is less than 0
  - getCategory
```
public Event.Category getCategory()
```
    Returns the category of the event
    
    Returns:
    
    The category of the event
  - setCategory
```
public void setCategory(Event.Category category)
```
    Sets the category of the event
    
    Parameters:
    
    category - The new event's category
  - getDescription
```
public String getDescription()
```
    Returns the description of the event.
    
    Returns:
    
    The description of the event
  - setDescription
```
public void setDescription(String description)
```
    Sets the description of the event
    
    Parameters:
    
    description - The new event's description
    
    Throws:
    
    IllegalArgumentException - If the description is 50 characters long or less than 1 character
  - getLongDescription
```
public String getLongDescription()
```
    Returns the long description of the event
    
    Returns:
    
    the long description of the event
  - setLongDescription
```
public void setLongDescription(String longDescription)
```
    Sets the long description of the event
    
    Parameters:
    
    longDescription - The new event's long description
    
    Throws:
    
    IllegalArgumentException - If the long description is 255 characters long or less than 1 character
  - getEventDate
```
public Date getEventDate()
```
    Returns event date.
    
    Returns:
    
    the event date
  - setEventDate
```
public void setEventDate(Date eventDate)
```
    Sets the event date
    
    Parameters:
    
    eventDate - The new event's date
  - getLocation
```
public String getLocation()
```
    Returns the location of the event
    
    Returns:
    
    the location of the event
  - setLocation
```
public void setLocation(String location)
```
    Sets the location of the event
    
    Parameters:
    
    location - The new event's location
  - getParticipants
```
public int getParticipants()
```
    Returns the participants of the event
    
    Returns:
    
    the participants of the event
  - setParticipants
```
public void setParticipants(int participants)
```
    Sets the participants of the event
    
    Parameters:
    
    participants - The new event's participants
    
    Throws:
    
    IllegalArgumentException - If participants are more than 11 persons and less than 1 person.
  - getParticipantsList
```
public List<User> getParticipantsList()
```
    Returns the list of event participants
    
    Returns:
    
    the list of event participants
  - getCreator
```
public User getCreator()
```
    Returns the owner of the event
    
    Returns:
    
    the event's owner
  - setCreator
```
public void setCreator(User creator)
```
    Sets the owner of the event
    
    Parameters:
    
    creator - The new owner of the event
  - addParticipant
```
public void addParticipant(User participant)
```
    Adds a participant to an event and increase the participants number for that event
    
    Parameters:
    
    participant - The new participant in the event
    
    Throws:
    
    NullPointerException - if null is passed as parameter
  - addCreator
```
public void addCreator(User creator)
```
    Adds a creator to an event
    
    Parameters:
    
    creator - The new owner in the event.
    
    Throws:
    
    NullPointerException - if null is passed as parameter

Class Event

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Event

Event

Event

Method Detail

getId

setId

getTitle

setTitle

getDuration

setDuration

getCategory

setCategory

getDescription

setDescription

getLongDescription

setLongDescription

getEventDate

setEventDate

getLocation

setLocation

getParticipants

setParticipants

getParticipantsList

getCreator

setCreator

addParticipant

addCreator