es.uvigo.esei.dgss.teama.microstories.rest

Class StoryResource

java.lang.Object

es.uvigo.esei.dgss.teama.microstories.rest.StoryResource

@Path(value="microstory")
public class StoryResource
extends Object

Resource that represents the microstories in the application.

Constructor Summary

Constructors

Constructor and Description
StoryResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	findById(int id) Returns the story identified by the id.
javax.ws.rs.core.Response	findByText(String text, int page, int limit) Returns a list of stories that matched by the text param.
javax.ws.rs.core.Response	findByThemeAndGenreAndDate(es.uvigo.esei.dgss.teama.microstories.domain.enums.Genre genre, es.uvigo.esei.dgss.teama.microstories.domain.enums.Theme theme, es.uvigo.esei.dgss.teama.microstories.domain.enums.DateRange dateRange, int page, int limit) Returns a list of stories that agree with the search params.
javax.ws.rs.core.Response	findMostRead() Returns a list of most read stories in the last month.
javax.ws.rs.core.Response	findRecentStories() Returns the most recent stories.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoryResource

public StoryResource()

Method Detail

findById

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

Returns the story identified by the id.

Parameters:

id - the id of a story.

Returns:

an OK response containing the Story with the provided id.

Throws:

IllegalArgumentException - if id is null or if it does not correspond with any story.

findRecentStories

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

Returns the most recent stories.

Returns:

an OK response containing the most recent stories.

findByText

@Path(value="/")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findByText(@QueryParam(value="contains")
                                                                                                        String text,
                                                                                                        @QueryParam(value="page")
                                                                                                        int page,
                                                                                                        @QueryParam(value="limit")
                                                                                                        int limit)

Returns a list of stories that matched by the text param.

Parameters:

text - the string that has to match

page - the number of page

limit - the number of stories in the page

Returns:

an OK response containing the Story list with the provided text param. A BAD_REQUEST response if the text is null or empty. An empty list if there are not any matches.

findByThemeAndGenreAndDate

@Path(value="search")
 @GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response findByThemeAndGenreAndDate(@QueryParam(value="genre")
                                                                                                                             es.uvigo.esei.dgss.teama.microstories.domain.enums.Genre genre,
                                                                                                                             @QueryParam(value="theme")
                                                                                                                             es.uvigo.esei.dgss.teama.microstories.domain.enums.Theme theme,
                                                                                                                             @QueryParam(value="publication")
                                                                                                                             es.uvigo.esei.dgss.teama.microstories.domain.enums.DateRange dateRange,
                                                                                                                             @QueryParam(value="page")
                                                                                                                             int page,
                                                                                                                             @QueryParam(value="limit")
                                                                                                                             int limit)

Returns a list of stories that agree with the search params.

Parameters:

theme - the theme of the story

genre - the genre of story

dateRange - the date ranges to filter

page - the number of page

limit - the number of stories in the page

Returns:

an OK response containing the Story list with the provided text param.

findMostRead

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

Returns a list of most read stories in the last month.

Returns:

an OK response containing a Story list with the most read stories in the last month.