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
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	advancedSearch(String search, Enum state, String category, int start, int count) Search for an event with advanced criteria
void	attendToEvent(int eventId) Register the current identified User into a Event.
void	cancelEvent(int eventId) Register the current identified User into a Event.
int	count(String search) Counts how many Events currently exist in the database.
int	countAll() Counts how many Events currently exist in the database.
int	countAttendingEvents() Retrieves a number of Events that authenticated User is joined.
int	countEventsOwnedBy(es.uvigo.esei.dgss.letta.domain.entities.User user) Returns the number of Event created by the given User
int	countEventsOwnedByCurrentUser() Returns the number of Event created by the current User
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.
Optional<es.uvigo.esei.dgss.letta.domain.entities.Event>	get(int id)
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.
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	getAttendingEventsOrderLocation(String location, int start, int count) Return a List of Events that authenticated User is joined ordered by location.
List<es.uvigo.esei.dgss.letta.domain.entities.Capital>	getCapitals() Gets all the Capital in the database.
es.uvigo.esei.dgss.letta.domain.entities.Event	getEvent(int id) Deprecated.
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	getEventsOwnedBy(es.uvigo.esei.dgss.letta.domain.entities.User user) Get events created by a specific user.
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	getEventsOwnedByCurrentUser() Deprecated. Consider using getEventsOwnedByCurrentUser(int, int) instead, that calls to getEventsOwnedBy(User, int, int)
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	getEventsOwnedByCurrentUser(int start, int count) Get the Event created by the active User.
Optional<es.uvigo.esei.dgss.letta.domain.entities.Event>	getWithAttendees(int id)
boolean	isCancelled(int eventId) Retrieves if a event is cancelled.
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	listByCreatedAt(int start, int count) Returns a paginated List of Events, sorted by descending creation date (which means that newer events will be first on the list).
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>	listByLocation(String location, int start, int count) Returns a paginated List of Events, sorted by nearest locations and 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.
void	modifyEvent(es.uvigo.esei.dgss.letta.domain.entities.Event modified) Modifies an existent Event if the currently identified user is the owner.
void	removeEvent(int eventId) Remove the current Event.
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.
List<es.uvigo.esei.dgss.letta.domain.entities.Event>	searchWhileLoggedIn(String search, String location, int start, int count) Modification of the search method that orders by distance from the residence place
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

get

@PermitAll
public Optional<es.uvigo.esei.dgss.letta.domain.entities.Event> get(int id)

getEvent

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

Deprecated.

getWithAttendees

@PermitAll
public Optional<es.uvigo.esei.dgss.letta.domain.entities.Event> getWithAttendees(int id)

count

@PermitAll
public int count(String search)

Counts how many Events currently exist in the database.

Parameters:

search - string to search

Returns:

An integer value representing the total number of events.

countAll

@RolesAllowed(value="ADMIN")
public int countAll()

Counts how many Events currently exist in the database.

Returns:

An integer value representing the total number of events.

advancedSearch

@PermitAll
public List<es.uvigo.esei.dgss.letta.domain.entities.Event> advancedSearch(String search,
                                                                                      Enum state,
                                                                                      String category,
                                                                                      int start,
                                                                                      int count)

Search for an event with advanced criteria

Parameters:

search - Search term of the query(short description or title)

state - State of the event(cancelled or open)

category - Category of the event

start - Start page of the query

count - Number of elements per page

Returns:

result list 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.

listByCreatedAt

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

Returns a paginated List of Events, sorted by descending creation date (which means that newer 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:

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

Throws:

IllegalArgumentException - if the start or count parameters are negative.

listByLocation

@RolesAllowed(value={"USER","ADMIN"})
public List<es.uvigo.esei.dgss.letta.domain.entities.Event> listByLocation(String location,
                                                                                                                 int start,
                                                                                                                 int count)
                                                                                                          throws IllegalArgumentException

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

Parameters:

location - The location of the logged User.

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","ADMIN"})
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 and long 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.

searchWhileLoggedIn

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

Modification of the search method that orders by distance from the residence place

Parameters:

search - The search term

start - The start page

count - The number of elements per page

Returns:

a list with the results

Throws:

IllegalArgumentException

attendToEvent

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

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

IllegalArgumentException - if the Event does not exist

getAttendingEvents

@RolesAllowed(value={"USER","ADMIN"})
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.

getAttendingEventsOrderLocation

@RolesAllowed(value={"USER","ADMIN"})
public List<es.uvigo.esei.dgss.letta.domain.entities.Event> getAttendingEventsOrderLocation(String location,
                                                                                                                                  int start,
                                                                                                                                  int count)

Return a List of Events that authenticated User is joined ordered by location.

Returns:

A List of Events that authenticated User is joined ordered by location.

countAttendingEvents

@RolesAllowed(value={"USER","ADMIN"})
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

getEventsOwnedBy

@RolesAllowed(value={"USER","ADMIN"})
public List<es.uvigo.esei.dgss.letta.domain.entities.Event> getEventsOwnedBy(es.uvigo.esei.dgss.letta.domain.entities.User user)
                                                                                                            throws IllegalArgumentException

Get events created by a specific user.

Parameters:

user - the owner of the events.

Returns:

a list of Event that contains the owner`s events.

Throws:

IllegalArgumentException - if the user is null.

countEventsOwnedBy

@RolesAllowed(value={"USER","ADMIN"})
public int countEventsOwnedBy(es.uvigo.esei.dgss.letta.domain.entities.User user)

Returns the number of Event created by the given User

Parameters:

user - User for count his created Event

Returns:

The number of Event created by the given User

getEventsOwnedByCurrentUser

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

Deprecated. Consider using getEventsOwnedByCurrentUser(int, int) instead, that calls to getEventsOwnedBy(User, int, int)

Get events created by the active user.

Returns:

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

getEventsOwnedByCurrentUser

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

Get the Event created by the active User.

Parameters:

start - index of the first Event to retrieve.

count - number of Event to retrieve.

Returns:

a list of Event that contains the given number of events from the given position owned by the current User.

countEventsOwnedByCurrentUser

@RolesAllowed(value={"USER","ADMIN"})
public int countEventsOwnedByCurrentUser()

Returns the number of Event created by the current User

Returns:

the number of Event created by the current User

unattendToEvent

@RolesAllowed(value={"USER","ADMIN"})
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.

modifyEvent

@RolesAllowed(value={"USER","ADMIN"})
public void modifyEvent(es.uvigo.esei.dgss.letta.domain.entities.Event modified)
                                                       throws IllegalArgumentException,
                                                              UserNotAuthorizedException,
                                                              SecurityException

Modifies an existent Event if the currently identified user is the owner.

Parameters:

modified - the Event already modified

Throws:

SecurityException - if the currently identified user is not found in the database or if he is not the owner of the event.

IllegalArgumentException

UserNotAuthorizedException

cancelEvent

@RolesAllowed(value={"USER","ADMIN"})
public void cancelEvent(int eventId)
                                                       throws SecurityException,
                                                              EventIsCancelledException,
                                                              IllegalArgumentException,
                                                              IllegalEventOwnerException

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:

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

EventIsCancelledException - if the Event is cancelled

IllegalArgumentException - if the Event does not exist

IllegalEventOwnerException - if the event does not exist

isCancelled

@PermitAll
public boolean isCancelled(int eventId)
                               throws IllegalArgumentException

Retrieves if a event is cancelled.

Parameters:

eventId - the id of the Event to check

Returns:

true if the event is cancelled, false otherwhise

Throws:

IllegalArgumentException - if the event does not exist

getCapitals

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

Gets all the Capital in the database.

Returns:

The List with all the Capital

removeEvent

@RolesAllowed(value="ADMIN")
public void removeEvent(int eventId)
                                              throws IllegalArgumentException

Remove the current Event. Only a user with role ADMIN can call this.

Parameters:

eventId - Identifier of the Event to remove.

Throws:

IllegalArgumentException - if the Event does not exist