es.uvigo.esei.dgss.letta.service

Class EventEJB

java.lang.Object

es.uvigo.esei.dgss.letta.service.EventEJB

public class EventEJB
extends Object

EventEJB is a service bean providing all the required event-related methods.

Author:

Aitor Blanco Míguez, Borja Cordeiro González, Alberto Pardellas Soto, Adolfo Álvarez López, Adrián Rodríguez Fariña, Alberto Gutiérrez Jácome

Constructor Summary

Constructors

Constructor and Description
EventEJB()

Method Summary

Modifier and Type	Method and Description
void	attendToEvent(int eventId) Register the current identified User into a Event.
int	count() Counts how many Events currently exist in the database.
int	countAttendingEvents() Retrieves a number of Events that authenticated User is joined.
es.uvigo.esei.dgss.letta.domain.entities.Event	createEvent(es.uvigo.esei.dgss.letta.domain.entities.Event event) Creates a new Event in the database, setting its creator as the current identified User.
int	getAttendees(es.uvigo.esei.dgss.letta.domain.entities.Event event) Returns a int with the number of User attendants of the Event.
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	getAttendingEvents(int start, int count) Return a List of Events that authenticated User is joined.
es.uvigo.esei.dgss.letta.domain.entities.Event	getEvent(int id) Returns an Event
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	getEventsOwnedByCurrentUser() Get events created by the active user.
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	listByDate(int start, int count) Returns a paginated List of Events, sorted by ascending date (which means that older events will be first on the list).
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	listHighlighted() Returns a paginated List of Events with all the currently highlighted events, sorted by a magician.
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	search(String search, int start, int count) Searches for Events matching some given String query, and returns the results as a paginated List.
void	unattendToEvent(int eventId)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventEJB

public EventEJB()

Method Detail

count

@PermitAll
public int count()

Counts how many Events currently exist in the database.

Returns:

An integer value representing the total number of events.

listByDate

@PermitAll
public List<es.uvigo.esei.dgss.letta.domain.entities.Event> listByDate(int start,
                                                                                  int count)
                                                                           throws IllegalArgumentException

Returns a paginated List of Events, sorted by ascending date (which means that older events will be first on the list).

Parameters:

start - The first Event position to return, numbered from 0.

count - The number of Events to return.

Returns:

A sorted List with the specified number of Events, sorted by ascending date and counting from the received start point.

Throws:

IllegalArgumentException - if the start or count parameters are negative.

listHighlighted

@PermitAll
public List<es.uvigo.esei.dgss.letta.domain.entities.Event> listHighlighted()

Returns a paginated List of Events with all the currently highlighted events, sorted by a magician.

Returns:

A sorted List containing all the highlighted Events, magically sorted and counting from the received start point.

createEvent

@RolesAllowed(value="USER")
public es.uvigo.esei.dgss.letta.domain.entities.Event createEvent(es.uvigo.esei.dgss.letta.domain.entities.Event event)
                                                                                       throws IllegalArgumentException,
                                                                                              SecurityException

Creates a new Event in the database, setting its creator as the current identified User.

Parameters:

event - The Event to be inserted into the database.

Returns:

The created Event object with all its auto-generated fields (the event Event.getId() id) already set.

Throws:

IllegalArgumentException - if the received Event is null

SecurityException - if the currently identified user is not found in the database (!!!).

search

@PermitAll
public List<es.uvigo.esei.dgss.letta.domain.entities.Event> search(String search,
                                                                              int start,
                                                                              int count)
                                                                       throws IllegalArgumentException

Searches for Events matching some given String query, and returns the results as a paginated List. If the given search pattern is null, a NullPointerException will be thrown.
The method will search inside the event's title and short description. Results are sorted by ascending date and descending number of attendees.

Parameters:

search - The search pattern as a simple String.

start - The first Event position to return, counting from 0.

count - The number of Events to return.

Returns:

A sorted List with the specified number of Events that have matched the search query.

Throws:

IllegalArgumentException - if the received String with the search terms is null, or if the start or count parameters are negative.

attendToEvent

@RolesAllowed(value="USER")
public void attendToEvent(int eventId)
                                               throws EventAlredyJoinedException,
                                                      SecurityException,
                                                      EventIsCancelledException

Register the current identified User into a Event. It the the current User is already registered for the event the method will throw an EventAlredyJoinedException, otherwise it will register the User to the event.

Parameters:

eventId - Identifier of the Event that the User wants to register.

Throws:

EventAlredyJoinedException - if the current identified User is already registered for the Event.

SecurityException - if the currently identified user is not found in the database (!!!).

EventIsCancelledException - if the Event is cancelled

getAttendingEvents

@RolesAllowed(value="USER")
public List<es.uvigo.esei.dgss.letta.domain.entities.Event> getAttendingEvents(int start,
                                                                                                           int count)

Return a List of Events that authenticated User is joined.

Returns:

A List of Events that authenticated User is joined.

countAttendingEvents

@RolesAllowed(value="USER")
public int countAttendingEvents()
                                                     throws SecurityException

Retrieves a number of Events that authenticated User is joined. This function is useful to do the paginate of the list of events.

Returns:

A number (int) of Events that authenticated User is joined.

Throws:

SecurityException

getEventsOwnedByCurrentUser

@RolesAllowed(value="USER")
public List<es.uvigo.esei.dgss.letta.domain.entities.Event> getEventsOwnedByCurrentUser()

Get events created by the active user.

Returns:

a list of Event that contains events of the current user.

unattendToEvent

@RolesAllowed(value="USER")
public void unattendToEvent(int eventId)
                                                 throws SecurityException,
                                                        EventNotJoinedException

Throws:

SecurityException

EventNotJoinedException

getAttendees

@PermitAll
public int getAttendees(es.uvigo.esei.dgss.letta.domain.entities.Event event)

Returns a int with the number of User attendants of the Event.

Parameters:

event - the Event to get the attendants.

Returns:

A int with the number of attendants.

getEvent

@PermitAll
public es.uvigo.esei.dgss.letta.domain.entities.Event getEvent(int id)

Returns an Event

Parameters:

id - indicates the Event id.

Returns:

A Event if it is found, null otherwise