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

Class StoryResource

java.lang.Object

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

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

Resource that represents the stories in the application.

Author:

Miguel Ferreiro Díaz, Fernando Campos Tato, Roi Pérez López

Constructor Summary

Constructors

Constructor and Description
StoryResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	get(int id) Return the current story
javax.ws.rs.core.Response	listMostReadedStories(String initialDateStr, String finalDateStr) Returns the two most readed stories from each category in a date range
javax.ws.rs.core.Response	listRecent() Returns the six most recent stories ordered by date.
javax.ws.rs.core.Response	listStories(int maxItems, int page, es.uvigo.esei.dgss.teama.microstories.domain.Topics genre, es.uvigo.esei.dgss.teama.microstories.domain.Type theme, long publication) Return filtered matching stories
javax.ws.rs.core.Response	searchStorieByText(String contains, int page, int maxItems) Returns stories by text.

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

get

@Path(value="{id}")
 @GET
public javax.ws.rs.core.Response get(@PathParam(value="id")
                                                               int id)
                                                        throws SecurityException

Return the current story

Parameters:

id -

Returns:

the current story

Throws:

SecurityException

listRecent

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

Returns the six most recent stories ordered by date.

Returns:

an OK response containing a list of stories.

searchStorieByText

@Path(value="")
 @GET
public javax.ws.rs.core.Response searchStorieByText(@DefaultValue(value="") @QueryParam(value="contains")
                                                                          String contains,
                                                                          @DefaultValue(value="0") @QueryParam(value="page")
                                                                          int page,
                                                                          @DefaultValue(value="10") @QueryParam(value="maxItems")
                                                                          int maxItems)

Returns stories by text. The result is paginate by maxItems and page.

Parameters:

contains -

page -

maxItems -

Returns:

an OK response containing a list of stories.

listMostReadedStories

@Path(value="/hottest")
 @GET
public javax.ws.rs.core.Response listMostReadedStories(@QueryParam(value="initialDate")
                                                                                     String initialDateStr,
                                                                                     @QueryParam(value="finalDate")
                                                                                     String finalDateStr)

Returns the two most readed stories from each category in a date range

Parameters:

initialDateStr -

finalDateStr -

Returns:

an OK response containing a list of stories.

listStories

@Path(value="/filter")
 @GET
public javax.ws.rs.core.Response listStories(@QueryParam(value="maxItems") @DefaultValue(value="10")
                                                                          int maxItems,
                                                                          @QueryParam(value="page") @DefaultValue(value="0")
                                                                          int page,
                                                                          @QueryParam(value="genre")
                                                                          es.uvigo.esei.dgss.teama.microstories.domain.Topics genre,
                                                                          @QueryParam(value="theme")
                                                                          es.uvigo.esei.dgss.teama.microstories.domain.Type theme,
                                                                          @QueryParam(value="publication")
                                                                          long publication)

Return filtered matching stories

Parameters:

maxItems -

page -

genre -

theme -

publication -

Returns:

an OK response containing a filtered list of stories.