Event (Domain 0.2.0-SNAPSHOT API)

java.lang.Object
- es.uvigo.esei.dgss.letta.domain.entities.Event

```
@Entity
public class Event
extends Object
```
Event is a JPA entity that represents an event of the application.

Author:

Adolfo Álvarez López, Alberto Pardellas Soto, Aitor Blanco Míguez, Alberto Gutiérrez Jácome

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Event.Category` Enum representing all the available event categories: Books, Internet, Movies, Music, Sports, Television, Theatre and Travels.

Constructor Summary

Constructors
Constructor and Description
`Event(Event.Category category, String title, String summary, LocalDateTime date, String location, String description)` Constructs a new instance of `Event`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAttendee(User attendee)` Adds a new `User` to this event's attendees set.
`int`	`countAttendees()` Returns the current number of attendees of this event.
`boolean`	`equals(Object that)`
`Set<User>`	`getAttendees()` Returns the attendees of this event, as an unmodifiable `Set` of `Users`.
`Event.Category`	`getCategory()` Returns the `Event.Category` of the event.
`LocalDateTime`	`getDate()` Returns the event's date as a `LocalDateTime`.
`String`	`getDescription()` Retrieves the long description of a event
`int`	`getId()` Returns the identifier of the event.
`String`	`getLocation()` Returns the event's location as a `String`.
`User`	`getOwner()` Returns the event's owner as an `User`.
`String`	`getSummary()` Returns the event's summary as a `String`.
`String`	`getTitle()` Returns the event's title as a `String`.
`boolean`	`hasAttendee(User attendee)` Checks whether a given `User` is an attendee of the current event.
`int`	`hashCode()`
`boolean`	`isCancelled()` Returns if the event is cancelled
`void`	`removeAttendee(User attendee)` Removes an `User` from this event's attendees set.
`void`	`setCancelled(boolean cancelled)` Changes if the event is cancelled
`void`	`setCategory(Event.Category category)` Changes the `Event.Category` of the event.
`void`	`setDate(LocalDateTime date)` Changes the date of the event.
`void`	`setDescription(String description)` Changes if the event long description is modified
`void`	`setLocation(String location)` Changes the location of the event.
`void`	`setOwner(User owner)` Changes the owner of the event.
`void`	`setSummary(String summary)` Changes the summary of the event.
`void`	`setTitle(String title)` Changes the title of the event.
`String`	`toString()`

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

- Constructor Detail
  - Event
```
public Event(Event.Category category,
             String title,
             String summary,
             LocalDateTime date,
             String location,
             String description)
      throws IllegalArgumentException,
             NullPointerException
```
    Constructs a new instance of Event.
    
    Parameters:
    
    category - The Event.Category of the event. It cannot be null.
    
    title - A String with the title of the event. It must be non-null, non-empty and no greater than 20 characters.
    
    summary - A String with the summary of the event. It must be non-null, non-empty and no greater than 50 characters.
    
    date - The LocalDateTime of the event. It cannot be null.
    
    location - A String with the location of the event. It must be non-null, non-empty and no greater than 20 characters.
    
    Throws:
    
    IllegalArgumentException - If any of the Event's field requirements does not hold.
    
    NullPointerException - If any of the given arguments is null.
- Method Detail
  - getId
```
public int getId()
```
    Returns the identifier of the event.
    
    Returns:
    
    The identifier of the event.
  - getCategory
```
public Event.Category getCategory()
```
    Returns the Event.Category of the event.
    
    Returns:
    
    The category of the event.
  - setCategory
```
public void setCategory(Event.Category category)
                 throws NullPointerException
```
    Changes the Event.Category of the event.
    
    Parameters:
    
    category - The new event's category. It cannot be null.
    
    Throws:
    
    NullPointerException - If a null category is received.
  - getTitle
```
public String getTitle()
```
    Returns the event's title as a String.
    
    Returns:
    
    The title of the event.
  - setTitle
```
public void setTitle(String title)
              throws IllegalArgumentException,
                     NullPointerException
```
    Changes the title of the event.
    
    Parameters:
    
    title - The new event's title as a String. It cannot be null, empty nor greater than 20 characters.
    
    Throws:
    
    IllegalArgumentException - If the title is empty or its length exceeds the limit of 20 characters.
    
    NullPointerException - If a null title is received.
  - getSummary
```
public String getSummary()
```
    Returns the event's summary as a String.
    
    Returns:
    
    The summary of the event.
  - setSummary
```
public void setSummary(String summary)
                throws IllegalArgumentException,
                       NullPointerException
```
    Changes the summary of the event.
    
    Parameters:
    
    summary - The new event's summary as a String. It cannot be null, empty nor greater than 50 characters.
    
    Throws:
    
    IllegalArgumentException - If the summary is empty or its length exceeds the limit of 50 characters.
    
    NullPointerException - If a null summary is received.
  - getDate
```
public LocalDateTime getDate()
```
    Returns the event's date as a LocalDateTime.
    
    Returns:
    
    The date of the event.
  - setDate
```
public void setDate(LocalDateTime date)
             throws NullPointerException
```
    Changes the date of the event.
    
    Parameters:
    
    date - The new event's date as a LocalDateTime. It cannot be null.
    
    Throws:
    
    NullPointerException - If a null date is received.
  - getLocation
```
public String getLocation()
```
    Returns the event's location as a String.
    
    Returns:
    
    The location of the event.
  - setLocation
```
public void setLocation(String location)
                 throws IllegalArgumentException,
                        NullPointerException
```
    Changes the location of the event.
    
    Parameters:
    
    location - The new event's location as a String. It cannot be null, empty nor greater than 20 characters.
    
    Throws:
    
    IllegalArgumentException - If the location is empty or its length exceeds the limit of 20 characters.
    
    NullPointerException - If a null location is received.
  - getOwner
```
public User getOwner()
```
    Returns the event's owner as an User.
    
    Returns:
    
    The owner of the event.
  - setOwner
```
public void setOwner(User owner)
              throws NullPointerException
```
    Changes the owner of the event.
    
    Parameters:
    
    owner - The new event's owner as an User. It cannot be null.
    
    Throws:
    
    NullPointerException - If a null owner is received.
  - isCancelled
```
public boolean isCancelled()
```
    Returns if the event is cancelled
    
    Returns:
    
    true if the event is cancelled, false otherwise
  - setCancelled
```
public void setCancelled(boolean cancelled)
```
    Changes if the event is cancelled
    
    Parameters:
    
    cancelled - global variable
  - getDescription
```
public String getDescription()
```
    Retrieves the long description of a event
    
    Returns:
    
    the long description of a event
  - setDescription
```
public void setDescription(String description)
```
    Changes if the event long description is modified
    
    Parameters:
    
    description - global variable
  - countAttendees
```
public int countAttendees()
```
    Returns the current number of attendees of this event.
    
    Returns:
    
    The number of attendees of the event.
  - hasAttendee
```
public boolean hasAttendee(User attendee)
```
    Checks whether a given User is an attendee of the current event.
    
    Parameters:
    
    attendee - The user to check if it is an attendee of the event.
    
    Returns:
    
    True if the user is an attendee, false otherwise.
  - getAttendees
```
public Set<User> getAttendees()
```
    Returns the attendees of this event, as an unmodifiable Set of Users.
    
    Returns:
    
    The attendees of the event.
  - addAttendee
```
public void addAttendee(User attendee)
                 throws IllegalArgumentException,
                        NullPointerException
```
    Adds a new User to this event's attendees set.
    
    Parameters:
    
    attendee - The new user to add to the attendees set. It cannot be null nor already contained in the attendees set.
    
    Throws:
    
    IllegalArgumentException - If the received user already is part of this event's attendees set.
    
    NullPointerException - If a null attendee is received.
  - removeAttendee
```
public void removeAttendee(User attendee)
                    throws IllegalArgumentException,
                           NullPointerException
```
    Removes an User from this event's attendees set.
    
    Parameters:
    
    attendee - The user to remove from the attendees set. It cannot be null, and must be contained in the attendees set.
    
    Throws:
    
    IllegalArgumentException - If the received user is not part of this event's attendees set.
    
    NullPointerException - If a null attendee is received.
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object that)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Event

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Event

Method Detail

getId

getCategory

setCategory

getTitle

setTitle

getSummary

setSummary

getDate

setDate

getLocation

setLocation

getOwner

setOwner

isCancelled

setCancelled

getDescription

setDescription

countAttendees

hasAttendee

getAttendees

addAttendee

removeAttendee

hashCode

equals

toString