es.uvigo.esei.dgss.teamc.microstories.service

Class StoryService

java.lang.Object

es.uvigo.esei.dgss.teamc.microstories.service.StoryService

@PermitAll
public class StoryService
extends Object

EJB for Stories.

Author:

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

Constructor Summary

Constructors

Constructor and Description
StoryService()

Method Summary

Modifier and Type	Method and Description
Long	countExploreStories(es.uvigo.esei.dgss.teamc.microstories.entities.Genre genre, es.uvigo.esei.dgss.teamc.microstories.entities.Theme theme, Date today, DateRange dateRange) Returns the number of stories matching given values for not null arguments.
Long	countExploreStories(es.uvigo.esei.dgss.teamc.microstories.entities.Genre genre, es.uvigo.esei.dgss.teamc.microstories.entities.Theme theme, DateRange dateRange) Returns the number of stories matching given values for not null arguments.
es.uvigo.esei.dgss.teamc.microstories.entities.Story	create(es.uvigo.esei.dgss.teamc.microstories.entities.Story story) Creates a new story written by current user.
List<es.uvigo.esei.dgss.teamc.microstories.entities.Story>	exploreStories(es.uvigo.esei.dgss.teamc.microstories.entities.Genre genre, es.uvigo.esei.dgss.teamc.microstories.entities.Theme theme, Date today, DateRange dateRange, int pageSize, int pageIndex) Returns a list of stories matching given values for not null arguments.
List<es.uvigo.esei.dgss.teamc.microstories.entities.Story>	exploreStories(es.uvigo.esei.dgss.teamc.microstories.entities.Genre genre, es.uvigo.esei.dgss.teamc.microstories.entities.Theme theme, DateRange dateRange, int pageSize, int pageIndex) Returns the number of stories matching given values for not null arguments.
es.uvigo.esei.dgss.teamc.microstories.entities.Story	get(Long id) Returns the Story with the given id
Long	getNumberStoriesByAuthor(String author) Returns the number of stories created by an author
Long	getNumberStoriesByText(String text) Returns the number of stories matching the search text
List<es.uvigo.esei.dgss.teamc.microstories.entities.Story>	getStoriesByAuthor(String author, int noOfStories, int pageIndex) Returns the stories created by a given author order by date
List<es.uvigo.esei.dgss.teamc.microstories.entities.Story>	getStoriesByText(String text, int noOfStories, int pageIndex) Returns a list of stories filtered by a string
List<es.uvigo.esei.dgss.teamc.microstories.entities.Story>	listHottest() Returns last month's 2 most read stories of each genre sorted by number of views.
List<es.uvigo.esei.dgss.teamc.microstories.entities.Story>	listHottest(Date today) Returns last month's 2 most read stories of each genre sorted by number of views.
List<es.uvigo.esei.dgss.teamc.microstories.entities.Story>	listRecent() Returns the 6 most recent Stories
es.uvigo.esei.dgss.teamc.microstories.entities.Story	update(es.uvigo.esei.dgss.teamc.microstories.entities.Story story) Updates a story.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoryService

public StoryService()

Method Detail

listRecent

public List<es.uvigo.esei.dgss.teamc.microstories.entities.Story> listRecent()

Returns the 6 most recent Stories

Returns:

the 6 most recent Stories

get

public es.uvigo.esei.dgss.teamc.microstories.entities.Story get(Long id)
                                                         throws IllegalArgumentException

Returns the Story with the given id

Parameters:

id - the id of the Story to return

Returns:

the Story identified by given id

Throws:

IllegalArgumentException - if given id is null

getStoriesByText

public List<es.uvigo.esei.dgss.teamc.microstories.entities.Story> getStoriesByText(String text,
                                                                                   int noOfStories,
                                                                                   int pageIndex)
                                                                            throws IllegalArgumentException

Returns a list of stories filtered by a string

Parameters:

text - search string to filter the list

noOfStories - number of stories to be shown per page

pageIndex - index of page to be shown

Returns:

a list of stories filtered by a search string

Throws:

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

getNumberStoriesByText

public Long getNumberStoriesByText(String text)

Returns the number of stories matching the search text

Returns:

the number of stories matching the search text

exploreStories

public List<es.uvigo.esei.dgss.teamc.microstories.entities.Story> exploreStories(es.uvigo.esei.dgss.teamc.microstories.entities.Genre genre,
                                                                                 es.uvigo.esei.dgss.teamc.microstories.entities.Theme theme,
                                                                                 Date today,
                                                                                 DateRange dateRange,
                                                                                 int pageSize,
                                                                                 int pageIndex)
                                                                          throws IllegalArgumentException

Returns a list of stories matching given values for not null arguments.

Parameters:

genre - genre to filter the stories by. It's not taken into account if it's null

theme - theme to filter the stories by. It's not taken into account if it0s null

today - date used as today's date in order to calculate the date range

dateRange - range of date to filter the stories. Can't be null

pageSize - number of stories to show per page. Can't be equal to or less than 0

pageIndex - index of the page to be returned. Can't be less than 0

Returns:

a list of stories matching given values for not null arguments

Throws:

IllegalArgumentException - if: - dateRange is null - pageSize is equal to or less than 0 - pageIndex is less than 0 or it refers to a page that is out of range

exploreStories

public List<es.uvigo.esei.dgss.teamc.microstories.entities.Story> exploreStories(es.uvigo.esei.dgss.teamc.microstories.entities.Genre genre,
                                                                                 es.uvigo.esei.dgss.teamc.microstories.entities.Theme theme,
                                                                                 DateRange dateRange,
                                                                                 int pageSize,
                                                                                 int pageIndex)
                                                                          throws IllegalArgumentException

Returns the number of stories matching given values for not null arguments.

Parameters:

genre - genre to filter the stories by. It's not taken into account if it's null

theme - theme to filter the stories by. It's not taken into account if it0s null

dateRange - range of date to filter the stories. Can't be null

pageSize - number of stories to show per page. Can't be equal to or less than 0

pageIndex - index of the page to be returned. Can't be less than 0

Returns:

a list of stories matching given values for not null arguments

Throws:

IllegalArgumentException - if: - dateRange is null - pageSize is equal to or less than 0 - pageIndex is less than 0 or it refers to a page that is out of range

countExploreStories

public Long countExploreStories(es.uvigo.esei.dgss.teamc.microstories.entities.Genre genre,
                                es.uvigo.esei.dgss.teamc.microstories.entities.Theme theme,
                                Date today,
                                DateRange dateRange)
                         throws IllegalArgumentException

Returns the number of stories matching given values for not null arguments.

Parameters:

genre - genre to filter the stories by. It's not taken into account if it's null

theme - theme to filter the stories by. It's not taken into account if it0s null

dateRange - range of date to filter the stories. Can't be null

Returns:

the number of stories matching given values for not null arguments

Throws:

IllegalArgumentException - if dateRange is null

countExploreStories

public Long countExploreStories(es.uvigo.esei.dgss.teamc.microstories.entities.Genre genre,
                                es.uvigo.esei.dgss.teamc.microstories.entities.Theme theme,
                                DateRange dateRange)
                         throws IllegalArgumentException

Returns the number of stories matching given values for not null arguments.

Parameters:

genre - genre to filter the stories by. It's not taken into account if it's null

theme - theme to filter the stories by. It's not taken into account if it0s null

dateRange - range of date to filter the stories. Can't be null

Returns:

the number of stories matching given values for not null arguments

Throws:

IllegalArgumentException - if dateRange is null

listHottest

public List<es.uvigo.esei.dgss.teamc.microstories.entities.Story> listHottest(Date today)

Returns last month's 2 most read stories of each genre sorted by number of views. If two or more stories have the same number of views, they will be sorted by publication date. If there's less than 2 stories of any genre, all stories of that genre are returned.

Parameters:

today - today's date

Returns:

a list containing last month's 2 most read stories of each genre

listHottest

public List<es.uvigo.esei.dgss.teamc.microstories.entities.Story> listHottest()

Returns last month's 2 most read stories of each genre sorted by number of views. If two or more stories have the same number of views, they will be sorted by publication date. If there's less than 2 stories of any genre, all stories of that genre are returned.

Returns:

a list containing last month's 2 most read stories of each genre

create

public es.uvigo.esei.dgss.teamc.microstories.entities.Story create(es.uvigo.esei.dgss.teamc.microstories.entities.Story story)

Creates a new story written by current user.

Parameters:

story - Story to be created

Returns:

the persistent created story

Throws:

IllegalArgumentException - if a story with the same id already exists

NullPointerException - if story is null

javax.ejb.EJBAccessException - if current user is not the story's author or if current user is not logged in

update

public es.uvigo.esei.dgss.teamc.microstories.entities.Story update(es.uvigo.esei.dgss.teamc.microstories.entities.Story story)

Updates a story.

Parameters:

story - Story to be updated

Returns:

the persistent updated story

Throws:

NullPointerException - if story is null

javax.ejb.EJBAccessException - if current user is not the story's author or if the current user not logged in

getStoriesByAuthor

public List<es.uvigo.esei.dgss.teamc.microstories.entities.Story> getStoriesByAuthor(String author,
                                                                                     int noOfStories,
                                                                                     int pageIndex)
                                                                              throws IllegalArgumentException

Returns the stories created by a given author order by date

Parameters:

author - author to filter the list

noOfStories - number of stories to be shown per page

pageIndex - index of page to be shown

Returns:

a list of stories filtered created by the author

Throws:

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

javax.ejb.EJBAccessException - if the current user not logged in

getNumberStoriesByAuthor

public Long getNumberStoriesByAuthor(String author)

Returns the number of stories created by an author

Parameters:

author - login of the author to retrieve the stories

Returns:

the number of stories created by an author