es.uvigo.esei.dgss.teamc.microstories.rest

Class StoryResource

java.lang.Object

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

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

Author:

Noelia García Hervella, Sara Del Rio Muñoz, Manuel Vázquez Augusto, David Vila Fenández

Field Summary

Fields

Modifier and Type	Field and Description
static int	PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
StoryResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	exploreStory(es.uvigo.esei.dgss.teamc.microstories.entities.Genre genre, es.uvigo.esei.dgss.teamc.microstories.entities.Theme theme, es.uvigo.esei.dgss.teamc.microstories.service.DateRange dateRange, int pageIndex, String today) Returns a list of stories filter by a search string
javax.ws.rs.core.Response	getStory(Long id) Returns a story by its id
javax.ws.rs.core.Response	listRecentStories() Returns the 6 most recent stories stored in the application.
javax.ws.rs.core.Response	searchStory(String searchString, int pageIndex) Returns a list of stories filter by a search string

Methods inherited from class java.lang.Object

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

Field Detail

PAGE_SIZE

public static final int PAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

StoryResource

public StoryResource()

Method Detail

listRecentStories

@Path(value="recent")
 @GET
public javax.ws.rs.core.Response listRecentStories()

Returns the 6 most recent stories stored in the application.

Returns:

an OK response containing the list of stories stored in the application.

getStory

@Path(value="{id}")
 @GET
public javax.ws.rs.core.Response getStory(@PathParam(value="id")
                                                                    Long id)

Returns a story by its id

Parameters:

id - id of the Story

Returns:

an OK response containing the story identified by given id

Throws:

IllegalArgumentException - if the given id it's null or there's no story identified by given id

searchStory

@GET
public javax.ws.rs.core.Response searchStory(@QueryParam(value="contains")
                                                  String searchString,
                                                  @QueryParam(value="page")
                                                  int pageIndex)

Returns a list of stories filter by a search string

Parameters:

searchString - String to filter stories

pageIndex - Page index of the list

Returns:

an OK response containing the list of stories filter by a search string

Throws:

IllegalArgumentException - if given text is null or the page index is out of range or negative

exploreStory

@Path(value="exploration")
 @GET
public javax.ws.rs.core.Response exploreStory(@QueryParam(value="genre")
                                                                               es.uvigo.esei.dgss.teamc.microstories.entities.Genre genre,
                                                                               @QueryParam(value="theme")
                                                                               es.uvigo.esei.dgss.teamc.microstories.entities.Theme theme,
                                                                               @QueryParam(value="publication")
                                                                               es.uvigo.esei.dgss.teamc.microstories.service.DateRange dateRange,
                                                                               @QueryParam(value="page")
                                                                               int pageIndex,
                                                                               @QueryParam(value="today")
                                                                               String today)

Returns a list of stories filter by a search string

Parameters:

genre - Genre type parameter to filter stories by genre

theme - Theme type parameter to filter stories by theme

dateRange - Date type parameter to filter stories by date

pageIndex - Page index of the list

Returns:

an OK response containing the list of stories filter by a genre, theme or publication