es.uvigo.esei.dgss.teama.letta.entities

Class Event

java.lang.Object

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

@Entity
public class Event
extends Object

Class that contains everything related to an event.

Author:

Rubén Anido Bande, Iván Garrido Pereira, Marcos Martínez Pérez

Constructor Summary

Constructors

Constructor and Description
Event() Default constructor.
Event(int id, User organizer, User creator, String title, String head, String description, Category category, String location, Date start, Date end)
Event(int id, User organizer, User creator, String title, String head, String description, Category category, String location, Date start, Date end, boolean canceled)
Event(String title, String head, String description, Category category, String location, Date start, Date end) Creates a new instance of Event
Event(User organizer, User creator, String title, String head, String description, Category category, String location, Date start, Date end) Creates a new instance of Event

Method Summary

Modifier and Type	Method and Description
void	addAttendee(User attendee) Adds a new User to this event's assistants set.
int	countAttendees() Returns the current number of attendees of this event.
boolean	equals(Object obj)
Set<User>	getAssistants() Returns the list of attendees of this event.
Category	getCategory() Returns the category of the event.
User	getCreator() Returns the creator of the event.
String	getDescription() Returns the description of the event.
Date	getEnd() Returns the date end of this event.
String	getHead() Returns the head of the event.
int	getId() Returns the id of the event.
String	getLocation() Returns the location of the event.
User	getOrganizer() Returns the organizer of the event.
Date	getStart() Returns the date start of this event.
String	getTitle() Returns the title of the event.
int	hashCode()
boolean	isAttendee(User attendee) Checks whether a given User is an attendee of the current event.
boolean	isCanceled() Checks if the event was canceled.
void	removeAttendee(User attendee) Removes an User from this event's assistants set.
void	setAssistants(User attendee) Sets a attendees of this event.
void	setCanceled(boolean isCanceled) Changes the status of event.
void	setCategory(Category category) Sets the category of this event.
void	setCreator(User creator) Sets the creator of this event.
void	setDescription(String description) Sets the description of this event.
void	setEnd(Date end) Sets the date end of this event.
void	setHead(String head) Sets the head of the event.
void	setLocation(String location) Sets the location of this event.
void	setOrganizer(User organizer) Sets the organizer of this event.
void	setStart(Date start) Sets the date start of this event.
void	setTitle(String title) Sets the title of this event.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Default constructor. Creates a new instance of Event with default values.

Event

public Event(int id,
             User organizer,
             User creator,
             String title,
             String head,
             String description,
             Category category,
             String location,
             Date start,
             Date end)

Event

public Event(int id,
             User organizer,
             User creator,
             String title,
             String head,
             String description,
             Category category,
             String location,
             Date start,
             Date end,
             boolean canceled)

Event

public Event(User organizer,
             User creator,
             String title,
             String head,
             String description,
             Category category,
             String location,
             Date start,
             Date end)

Creates a new instance of Event

Parameters:

organizer - the organizer of the event. This parameter must be a non null user.

creator - the creator of the event. This parameter must be a non null user.

title - the title of the event. This parameter must be a non empty and non null string with a maximum length of 20 chars.

head - the head of the event. This parameter must be a non empty and non null string with a maximum length of 50 chars.

description - the description of the event. This parameter must be a non empty and non null string with a maximum length of 255 chars.

category - the category of the event. This parameter is an enumerated of type Category that must be a non null.

location - the location of the event. This parameter must be a non empty and non null string with a maximum length of 255 chars.

start - the start date of this event. This parameter can not be null and the date can not be before the current date.

end - the end date of this event. This parameter can not be null and the date can not be before the start date.

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.

Event

public Event(String title,
             String head,
             String description,
             Category category,
             String location,
             Date start,
             Date end)

Creates a new instance of Event

Parameters:

title - the title of the event. This parameter must be a non empty and non null string with a maximum length of 20 chars.

head - the head of the event. This parameter must be a non empty and non null string with a maximum length of 50 chars.

description - the description of the event. This parameter must be a non empty and non null string with a maximum length of 255 chars.

category - the category of the event. This parameter is an enumerated of type Category that must be a non null.

location - the location of the event. This parameter must be a non empty and non null string with a maximum length of 255 chars.

start - the start date of this event. This parameter can not be null and the date can not be before the current date.

end - the end date of this event. This parameter can not be null and the date can not be before the start date.

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 the id of the event.

Returns:

the id of the event.

getOrganizer

public User getOrganizer()

Returns the organizer of the event.

Returns:

the organizer of the event.

setOrganizer

public void setOrganizer(User organizer)

Sets the organizer of this event.

Parameters:

organizer - the new organizer of the event. null values not supported.

Throws:

NullPointerException - if a null value is passed.

getCreator

public User getCreator()

Returns the creator of the event.

Returns:

the creator of the event.

setCreator

public void setCreator(User creator)

Sets the creator of this event.

Parameters:

creator - the new creator of the event. null values not supported.

Throws:

NullPointerException - if a null value is passed.

getTitle

public String getTitle()

Returns the title of the event.

Returns:

the title of the event.

setTitle

public void setTitle(String title)

Sets the title of this event.

Parameters:

title - the new title of the event. This parameter must be a non empty and non null string with a maximum length of 20 chars.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the length of the string passed is not valid.

getHead

public String getHead()

Returns the head of the event. The head is a small description longer than title and shorter than description.

Returns:

the head of the event.

setHead

public void setHead(String head)

Sets the head of the event. The head is a small description longer than title and shorter than description.

Parameters:

head - the new head of the event. This parameter must be a non empty and non null string with a maximum length of 50 chars.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the length of the string passed is not valid.

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 this event.

Parameters:

description - the new description of the event. This parameter must be a non empty and non null string with a maximum length of 255 chars.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the length of the string passed is not valid.

getCategory

public Category getCategory()

Returns the category of the event.

Returns:

the category of the event.

setCategory

public void setCategory(Category category)

Sets the category of this event.

Parameters:

category - the new category of the event. This parameter is an enumerated of type Category that must be a non null.

Throws:

NullPointerException - if a null value is passed.

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 this event.

Parameters:

location - the new location of the event. This parameter must be a non empty and non null string with a maximum length of 255 chars.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the length of the string passed is not valid.

getStart

public Date getStart()

Returns the date start of this event.

Returns:

the date start of this event.

setStart

public void setStart(Date start)

Sets the date start of this event.

Parameters:

start - the new date of start for this event. This parameter can not be null and the date can not be before the 1900 year.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the value provided is before the 1900 year.

getEnd

public Date getEnd()

Returns the date end of this event.

Returns:

the date end of this event.

setEnd

public void setEnd(Date end)

Sets the date end of this event.

Parameters:

end - the new date of end for this event. This parameter can not be null and the date can not be before the start date.

Throws:

NullPointerException - if a null value is passed.

IllegalArgumentException - if the value provided is before the start date.

getAssistants

public Set<User> getAssistants()

Returns the list of attendees of this event.

Returns:

the list of attendees of this event.

setAssistants

public void setAssistants(User attendee)

Sets a attendees of this event. null values not supported.

Parameters:

attendee - a new attendee of the event. null values not supported.

Throws:

NullPointerException - if a null value is passed.

countAttendees

public int countAttendees()

Returns the current number of attendees of this event.

Returns:

The number of attendees of the event.

isAttendee

public boolean isAttendee(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.

addAttendee

public void addAttendee(User attendee)
                 throws IllegalArgumentException,
                        NullPointerException

Adds a new User to this event's assistants set.

Parameters:

attendee - The new user to add to the assistants set. It cannot be null nor already contained in the assistants set.

Throws:

IllegalArgumentException - If the received user already is part of this event's assistants set.

NullPointerException - If a null attendee is received.

removeAttendee

public void removeAttendee(User attendee)
                    throws IllegalArgumentException,
                           NullPointerException

Removes an User from this event's assistants set.

Parameters:

attendee - The user to remove from the assistants set. It cannot be null, and must be contained in the assistants set.

Throws:

IllegalArgumentException - If the received user is not part of this event's assistants set.

NullPointerException - If a null attendee is received.

isCanceled

public boolean isCanceled()

Checks if the event was canceled.

Returns:

true if the event was canceled.

setCanceled

public void setCanceled(boolean isCanceled)

Changes the status of event.

Parameters:

isCanceled - if the value is true the event will be canceled.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object