EventREST (REST 0.2.0-SNAPSHOT API)

java.lang.Object
- es.uvigo.esei.dgss.lettab.rest.EventREST

@Path(value="event")
 @Produces(value="application/json")
public class EventREST
extends Object

EventREST Class to the REST logic with all information for user's events

Author:: pvfernandez

Constructor Summary

Constructors
Constructor and Description

EventREST()

Constructors
Constructor and Description
`EventREST()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`javax.ws.rs.core.Response`	`cancelEvent(es.uvigo.esei.dgss.lettab.domain.Event event)` Cancel an event
`javax.ws.rs.core.Response`	`createEvent(String login, es.uvigo.esei.dgss.lettab.domain.Event event)` Creates an event
`javax.ws.rs.core.Response`	`getEventById(int id)` Obtains a detail of Event passed by id
`javax.ws.rs.core.Response`	`getFrontpageEvents()` Obtains a list with 20 events to show in the front page if the number of events in the system is less than 20 return all the events.
`javax.ws.rs.core.Response`	`getMyCreatedEvents(String login)` Gets the events created by the given user
`javax.ws.rs.core.Response`	`getMyJoinedEvents(String login)` Obtains a list with all the events in which one user has joined and show that list
`javax.ws.rs.core.Response`	`getPoupularEvents()` Obtains a list with the first five most popular events and show it.
`javax.ws.rs.core.Response`	`modifyEventById(int id, es.uvigo.esei.dgss.lettab.domain.Event event)`
`javax.ws.rs.core.Response`	`searchEvent(String text)` REST Method to retrieve a list of events that agree the search pattern in JSON

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

Constructor Detail
- EventREST
```
public EventREST()
```

Method Detail

getMyJoinedEvents

@GET
 @Produces(value="application/json")
 @Path(value="joined/{login}")
public javax.ws.rs.core.Response getMyJoinedEvents(@PathParam(value="login")
                                                                                                                            String login)

Obtains a list with all the events in which one user has joined and show that list

Parameters:: login - the login of the user calling for his events
Returns:: Response listOfJoinedEvents

getPoupularEvents

@GET
 @Produces(value="application/json")
 @Path(value="popular")
public javax.ws.rs.core.Response getPoupularEvents()

Obtains a list with the first five most popular events and show it.

Returns:: Response popularEvents

getFrontpageEvents
```
@GET
 @Produces(value="application/json")
 @Path(value="frontpage")
public javax.ws.rs.core.Response getFrontpageEvents()
```
Obtains a list with 20 events to show in the front page if the number of events in the system is less than 20 return all the events.

Returns:

Response frontpageEvents

getEventById

@GET
 @Path(value="{id}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getEventById(@PathParam(value="id")
                                                                                                             int id)

Obtains a detail of Event passed by id

Parameters:: id - id of the event
Returns:: Response Event if it was ok status

modifyEventById

@PUT
 @Path(value="{id}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response modifyEventById(@PathParam(value="id")
                                                                                                                                                     int id,
                                                                                                                                                     es.uvigo.esei.dgss.lettab.domain.Event event)

Parameters:: id - id of the event; event - event data to modify
Returns:: Response Event if it was ok status

searchEvent

@GET
 @Path(value="search/{text}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response searchEvent(@PathParam(value="text")
                                                                                                                     String text)

REST Method to retrieve a list of events that agree the search pattern in JSON

Parameters:: text - The text to search in the events descriptions and titles
Returns:: Response The Response with the retrieved data if found

createEvent

@POST
 @Path(value="/{login}/create")
public javax.ws.rs.core.Response createEvent(@PathParam(value="login")
                                                                                   String login,
                                                                                   es.uvigo.esei.dgss.lettab.domain.Event event)

Creates an event

Parameters:: login - login of event's creator; event - event's data
Returns:: Response Event

getMyCreatedEvents

@GET
 @Path(value="/created/{login}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getMyCreatedEvents(@PathParam(value="login")
                                                                                                                               String login)

Gets the events created by the given user

Parameters:: login - The login of the user
Returns:: Response The events created by the given user

cancelEvent

@PUT
 @Path(value="/cancellation")
 @Produces(value="application/json")
public javax.ws.rs.core.Response cancelEvent(es.uvigo.esei.dgss.lettab.domain.Event event)

Cancel an event

Parameters:: event - id of the event
Returns:: Response The events canceled

Class EventREST

Constructor Summary