es.uvigo.esei.dgss.letta.domain.entities

Class Event

java.lang.Object

es.uvigo.esei.dgss.letta.domain.entities.Event

@Entity
public class Event
extends Object

An entity that represents an event of the application.

Author:

aalopez, apsoto, abmiguez

Constructor Summary

Constructors

Constructor and Description
Event(EventType eventType, String title, String shortDescription, Date date, String location) Creates a new instance of Event.
Event(EventType eventType, String title, String shortDescription, Date date, String location, User creator) Creates a new instance of Event.
Event(EventType eventType, String title, String shortDescription, Date date, String location, User creator, List<User> eventsJoinedByUsers) Creates a new instance of Event.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
User	getCreator() The getter for the event creator
Date	getDate() The getter for the date parameter.
List<User>	getEventsJoinedByUsers() Return all the users who have joined an event
EventType	getEventType() The getter for the eventType parameter.
int	getId() The getter for the id parameter.
String	getLocation() Extracts the value of the current Event's location.
String	getShortDescription() The getter for the description parameter.
String	getTitle() The getter for the title parameter.
int	hashCode()
void	setCreator(User creator) The setter for the event creator
void	setDate(Date date) The setter for the Date parameter.
void	setEventType(EventType eventType) The setter for the eventType parameter.
void	setLocation(String location) Sets the location of the current event to the received String.
void	setShortDescription(String shortDescription) The setter for the description parameter.
void	setTitle(String title) The setter for the title parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event(EventType eventType,
             String title,
             String shortDescription,
             Date date,
             String location)

Creates a new instance of Event.

Parameters:

eventType - the event type of the event. This paramenter must be a non null EventType.

title - the title of the envent. This paramenter must be a non null string with with a maximum length of 20.

shortDescription - the description of the event. This paramenter must be a non null string with with a maximum length of 50.

date - the date of the event. This paramenter must be a non null.

location - the location of the event

Event

public Event(EventType eventType,
             String title,
             String shortDescription,
             Date date,
             String location,
             User creator)

Creates a new instance of Event.

Parameters:

eventType - the event type of the event. This paramenter must be a non null EventType.

title - the title of the envent. This paramenter must be a non null string with with a maximum length of 20.

shortDescription - the description of the event. This paramenter must be a non null string with with a maximum length of 50.

date - the date of the event. This paramenter must be a non null.

location - the location of the event

creator - the creator of the event

Event

public Event(EventType eventType,
             String title,
             String shortDescription,
             Date date,
             String location,
             User creator,
             List<User> eventsJoinedByUsers)

Creates a new instance of Event.

Parameters:

eventType - the event type of the event. This paramenter must be a non null EventType.

title - the title of the envent. This paramenter must be a non null string with with a maximum length of 20.

shortDescription - the description of the event. This paramenter must be a non null string with with a maximum length of 50.

date - the date of the event. This paramenter must be a non null.

location - the location of the event

creator - the creator of the event

eventsJoinedByUsers - Users who was joined to the event

Method Detail

getEventType

public EventType getEventType()

The getter for the eventType parameter.

Returns:

the event type for the event.

setEventType

public void setEventType(EventType eventType)

The setter for the eventType parameter.

Parameters:

eventType - the event type of the event. This paramenter must be a non null EventType.

Throws:

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

getTitle

public String getTitle()

The getter for the title parameter.

Returns:

a string with the title of the event.

setTitle

public void setTitle(String title)

The setter for the title parameter.

Parameters:

title - the title of the envent. This paramenter must be a non null string with with a maximum length of 20.

Throws:

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

IllegalArgumentException - if value provided for the is not valid according to its description.

getShortDescription

public String getShortDescription()

The getter for the description parameter.

Returns:

a string with the description of the event.

setShortDescription

public void setShortDescription(String shortDescription)

The setter for the description parameter.

Parameters:

shortDescription - the description of the event. This paramenter must be a non null string with with a maximum length of 50.

Throws:

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

IllegalArgumentException - if value provided for description is not valid according to its description.

getDate

public Date getDate()

The getter for the date parameter.

Returns:

a Date with the date of the event.

setDate

public void setDate(Date date)

The setter for the Date parameter.

Parameters:

date - the date of the event. This paramenter must be a non null.

Throws:

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

getLocation

public String getLocation()

Extracts the value of the current Event's location.

Returns:

A String representing the Event's location.

setLocation

public void setLocation(String location)
                 throws NullPointerException,
                        IllegalArgumentException

Sets the location of the current event to the received String.

Parameters:

location - A no-null, non-empty String, which length is not greater than 100 characters.

Throws:

NullPointerException - If a null String is received.

IllegalArgumentException - If received String's length is not between 1 and 100.

getId

public int getId()

The getter for the id parameter.

Returns:

the unique id for the instance.

getCreator

public User getCreator()

The getter for the event creator

Returns:

the event creator

setCreator

public void setCreator(User creator)

The setter for the event creator

Parameters:

creator - represents the event creator

getEventsJoinedByUsers

public List<User> getEventsJoinedByUsers()

Return all the users who have joined an event

Returns:

all the users who have joined an event

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object