es.uvigo.esei.dgss.teamd.ligaaas.rest

Class CompetitionRest

java.lang.Object

es.uvigo.esei.dgss.teamd.ligaaas.rest.CompetitionRest

@Path(value="/competition")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public class CompetitionRest
extends Object

Constructor Summary

Constructors

Constructor and Description
CompetitionRest()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	create(es.uvigo.esei.dgss.teamd.ligaaas.domain.entities.Competition competition) Creates a new competition.
javax.ws.rs.core.Response	delete(String name) Deletes a competition.
javax.ws.rs.core.Response	get() Returns all competitions.
javax.ws.rs.core.Response	getByLocation(String location) Return the competitions that belong to the provided location.
javax.ws.rs.core.Response	getByName(String name) Returns the competition identified by the name.
javax.ws.rs.core.Response	getBySport(String sport) Return the competitions that belong to the provided sport.
javax.ws.rs.core.Response	update(es.uvigo.esei.dgss.teamd.ligaaas.domain.entities.Competition competition) Updates the information of a competition.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompetitionRest

public CompetitionRest()

Method Detail

get

@GET
public javax.ws.rs.core.Response get()

Returns all competitions.

Returns:

an OK response containing all competitions.

getByName

@Path(value="{name}")
 @GET
public javax.ws.rs.core.Response getByName(@PathParam(value="name")
                                                                       String name)

Returns the competition identified by the name.

Parameters:

name - the name of a competition.

Returns:

an OK response containing the Competition with the provided name.

getBySport

@Path(value="{sport}")
 @GET
public javax.ws.rs.core.Response getBySport(@PathParam(value="sport")
                                                                         String sport)

Return the competitions that belong to the provided sport.

Parameters:

sport - the sport name to search for

Returns:

an OK response containing the list of competitions belong to the provided sport.

getByLocation

@Path(value="{location}")
 @GET
public javax.ws.rs.core.Response getByLocation(@PathParam(value="location")
                                                                               String location)

Return the competitions that belong to the provided location.

Parameters:

location - the location name to realize the searching

Returns:

an OK response containing the list of competitions belong to the provided location.

create

@POST
public javax.ws.rs.core.Response create(es.uvigo.esei.dgss.teamd.ligaaas.domain.entities.Competition competition)
                                       throws SecurityException

Creates a new competition.

Parameters:

competition - a new competition to be stored.

Returns:

a CREATED response with the URI of the new competition in the Location header.

Throws:

IllegalArgumentException - if competition is null.

SecurityException

update

@PUT
public javax.ws.rs.core.Response update(es.uvigo.esei.dgss.teamd.ligaaas.domain.entities.Competition competition)
                                      throws SecurityException

Updates the information of a competition.

Parameters:

competition - a competition to be updated.

Returns:

an empty OK response.

Throws:

IllegalArgumentException - if competition is null.

SecurityException

delete

@Path(value="{name}")
 @DELETE
public javax.ws.rs.core.Response delete(@PathParam(value="name")
                                                                       String name)
                                                                throws SecurityException

Deletes a competition.

Parameters:

name - of the competition to be deleted.

Returns:

an empty OK response.

Throws:

SecurityException