eu.dnetlib.api.functionality

Interface RecommendationService

All Superinterfaces:

DriverService

public interface RecommendationService
extends DriverService

The class that manages Recommendation objects

Method Summary

Modifier and Type	Method and Description
void	addRecommendationToUser(String recommendationId, String userId)
String	generateAnnouncement(int index, boolean active, String announcementTitle, String announcementText, Date creationDate, Date expirationDate) creates a new recommendation of type announcement
String	generateCommunityRecommendation(int index, boolean active, String title, String recommendationText, Date creationDate, Date expirationDate, Set<String> communityIds) creates a new recommendation of type community
eu.dnetlib.domain.functionality.Recommendation	generateRecommendation(int index, boolean active, String title, String recommendationText, Date creationDate, Date expirationDate) creates a new recommendation
String	generateUserRecommendation(int index, boolean active, String title, String userId, String recommendationText, Date creationDate, Date expirationDate) creates a new recommendation of type user
List<String>	getAllAnnouncementIds() retrieves ths ids of all announcements
List<eu.dnetlib.domain.functionality.Recommendation>	getAllAnnouncements() retrieves the recommendation text of all announcements
List<String>	getAllCommunityRecommendations() retrieves all recommendations of type community, only the content
List<String>	getAllCommunityRecommendations(String communityId) retrieves all community recommendation content that are associated with a community
List<eu.dnetlib.domain.functionality.Recommendation>	getAllCommunityRecommendationsObj() retrieves all recommendations of type community, the objects
List<eu.dnetlib.domain.functionality.Recommendation>	getAllCommunityRecommendationsObj(String communityId) retrieves all community recommendation objects that are associated with a community.
List<String>	getAllUserRecommendations(String userId)
List<String>	getAnnouncements() retrieves the recommendation text of all announcements that haven't expired
List<String>	getCommunityRecommendations(String communityId)
List<String>	getCommunityRecommendationsForUser(String userId) gets all the community recommendation for a specific user
List<eu.dnetlib.domain.functionality.Recommendation>	getCommunityRecommendationsForUserObj(String userId) gets all the community recommendation objects for a specific user
List<eu.dnetlib.domain.functionality.Recommendation>	getCommunityRecommendationsObj(String communityId)
eu.dnetlib.domain.functionality.Recommendation	getRecommendation(String recommendationId) retrieves a recommendation
List<String>	getRecommendations(List<String> recommendationIds) retrieves the recommendation text of a Set of recommendations
String	getRecommendationText(String recommendationId) retrieves the text of a recommendation
void	removeAnnouncement(String announcementId) removes a recommendation of type announcement
void	removeCommunityRecommendation(String recommendationId) removes a recommendation of type community
void	removeRecommendation(String recommendationId) removes a recommendation
void	removeUserRecommendation(String recommendationId)
void	swapAnnouncements(String announcementId1, String announcementId2) Swap the index of 2 announcements
void	swapCommunityRecommendations(String announcementId1, String announcementId2) Swap the index of 2 community recommendations
void	swapUserRecommendations(String announcementId1, String announcementId2) Swap the index of 2 user recommendaitons
void	updateAnnouncement(String announcementId, int index, boolean active, String announcementTitle, String announcementText, Date creationDate, Date expirationDate) updates an announcement and the corresponding recommendation
void	updateCommunityRecommendation(String recommendationId, int index, boolean active, String title, String recommendationText, Date creationDate, Date expirationDate, Set<String> communityIds)
void	updateRecommendation(String recommendationId, int index, boolean active, String title, String recommendationText, Date creationDate, Date expirationDate) updates a recommendation

Methods inherited from interface eu.dnetlib.api.DriverService

identify, notify

Method Detail

generateAnnouncement

String generateAnnouncement(int index,
                            boolean active,
                            String announcementTitle,
                            String announcementText,
                            Date creationDate,
                            Date expirationDate)
                     throws RecommendationServiceException

creates a new recommendation of type announcement

Parameters:

recommendationText - the text of the recommendation

creationDate - the creation date of the announcement

expirationDate - the date the announcement expires

Returns:

the id of the new recommendation

Throws:

RecommendationWebServiceException - if the announcement cannot be created

RecommendationServiceException

swapAnnouncements

void swapAnnouncements(String announcementId1,
                       String announcementId2)
                throws RecommendationServiceException

Swap the index of 2 announcements

Parameters:

announcementId1 - the id of the fist announcement

announcementId2 - the id of the second announcement

Throws:

RecommendationServiceException

swapUserRecommendations

void swapUserRecommendations(String announcementId1,
                             String announcementId2)
                      throws RecommendationServiceException

Swap the index of 2 user recommendaitons

Parameters:

announcementId1 - the id of the fist announcement

announcementId2 - the id of the second announcement

Throws:

RecommendationServiceException

swapCommunityRecommendations

void swapCommunityRecommendations(String announcementId1,
                                  String announcementId2)
                           throws RecommendationServiceException

Swap the index of 2 community recommendations

Parameters:

announcementId1 - the id of the fist announcement

announcementId2 - the id of the second announcement

Throws:

RecommendationServiceException

generateRecommendation

eu.dnetlib.domain.functionality.Recommendation generateRecommendation(int index,
                                                                      boolean active,
                                                                      String title,
                                                                      String recommendationText,
                                                                      Date creationDate,
                                                                      Date expirationDate)
                                                               throws RecommendationServiceException

creates a new recommendation

Parameters:

index - the recommendation index

active - the state of the recommendaiton, is it active or not #param title the title of the recommendation

rText - the recommendation text

creationDate - the date the recommendation was created

expirationDate - the date the recommendation expires

Returns:

the id of the recommendation

Throws:

RecommendationServiceException - if the recommendation cannot be created

generateCommunityRecommendation

String generateCommunityRecommendation(int index,
                                       boolean active,
                                       String title,
                                       String recommendationText,
                                       Date creationDate,
                                       Date expirationDate,
                                       Set<String> communityIds)
                                throws RecommendationServiceException

creates a new recommendation of type community

Parameters:

recommendationText - the recommendation text

creationDate -

expirationDate -

communityId - the ids of the associated communities

Returns:

the id of the recommendation

Throws:

RecommendationServiceException - if the community recommendation cannot be created

generateUserRecommendation

String generateUserRecommendation(int index,
                                  boolean active,
                                  String title,
                                  String userId,
                                  String recommendationText,
                                  Date creationDate,
                                  Date expirationDate)
                           throws RecommendationServiceException

creates a new recommendation of type user

Parameters:

recommendationText -

creationDate -

expirationDate -

Returns:

the id of the recommendation

Throws:

RecommendationServiceException - if the user recommendation cannot be created

getAnnouncements

List<String> getAnnouncements()
                       throws RecommendationServiceException

retrieves the recommendation text of all announcements that haven't expired

Returns:

the announcements' recommendation text

Throws:

RecommendationServiceException

getAllAnnouncementIds

List<String> getAllAnnouncementIds()
                            throws RecommendationServiceException

retrieves ths ids of all announcements

Throws:

RecommendationServiceException

getAllAnnouncements

List<eu.dnetlib.domain.functionality.Recommendation> getAllAnnouncements()
                                                                  throws RecommendationServiceException

retrieves the recommendation text of all announcements

Returns:

the recommendation text of all announcements

Throws:

RecommendationServiceException

getAllCommunityRecommendations

List<String> getAllCommunityRecommendations()
                                     throws RecommendationServiceException

retrieves all recommendations of type community, only the content

Returns:

the recommendation text of all community recommendations

Throws:

RecommendationServiceException

getAllCommunityRecommendationsObj

List<eu.dnetlib.domain.functionality.Recommendation> getAllCommunityRecommendationsObj()
                                                                                throws RecommendationServiceException

retrieves all recommendations of type community, the objects

Returns:

the recommendation text of all community recommendations

Throws:

RecommendationServiceException

getCommunityRecommendations

List<String> getCommunityRecommendations(String communityId)
                                  throws RecommendationServiceException

Throws:

RecommendationServiceException

getCommunityRecommendationsObj

List<eu.dnetlib.domain.functionality.Recommendation> getCommunityRecommendationsObj(String communityId)
                                                                             throws RecommendationServiceException

Throws:

RecommendationServiceException

getAllCommunityRecommendations

List<String> getAllCommunityRecommendations(String communityId)
                                     throws RecommendationServiceException

retrieves all community recommendation content that are associated with a community

Parameters:

communityId - the id of the community

Returns:

the recommendation text of the community recommendations

Throws:

RecommendationServiceException

getAllCommunityRecommendationsObj

List<eu.dnetlib.domain.functionality.Recommendation> getAllCommunityRecommendationsObj(String communityId)
                                                                                throws RecommendationServiceException

retrieves all community recommendation objects that are associated with a community.

Parameters:

communityId - the id of the community

Returns:

the recommendation text of the community recommendations

Throws:

RecommendationServiceException

getAllUserRecommendations

List<String> getAllUserRecommendations(String userId)
                                throws RecommendationServiceException

Throws:

RecommendationServiceException

getRecommendation

eu.dnetlib.domain.functionality.Recommendation getRecommendation(String recommendationId)
                                                          throws RecommendationServiceException

retrieves a recommendation

Parameters:

recommendationId - the recommendation id

Returns:

the recommendation or null if the recommendation does not exist

Throws:

RecommendationServiceException

getRecommendationText

String getRecommendationText(String recommendationId)
                      throws RecommendationServiceException

retrieves the text of a recommendation

Parameters:

recommendationId - the id of the recommendation

Returns:

the recommendation text or null if the recommendation does not exist

Throws:

RecommendationServiceException

getRecommendations

List<String> getRecommendations(List<String> recommendationIds)
                         throws RecommendationServiceException

retrieves the recommendation text of a Set of recommendations

Parameters:

recommendationIds - the ids of the recommendations

Returns:

a Set of the recommendations' text

Throws:

RecommendationServiceException

removeRecommendation

void removeRecommendation(String recommendationId)
                   throws RecommendationServiceException

removes a recommendation

Parameters:

recommendationId - the id of the recommendation

Throws:

RecommendationServiceException - if the recommendation does not exist or cannot be updated

removeAnnouncement

void removeAnnouncement(String announcementId)
                 throws RecommendationServiceException

removes a recommendation of type announcement

Parameters:

announcementId - the id of the announcement

Throws:

RecommendationServiceException - if the announcement does not exist or cannot be updated

removeCommunityRecommendation

void removeCommunityRecommendation(String recommendationId)
                            throws RecommendationServiceException

removes a recommendation of type community

Parameters:

recommendationId - the id of the recommendation

communityId - the id of the community

Throws:

RecommendationServiceException

removeUserRecommendation

void removeUserRecommendation(String recommendationId)
                       throws RecommendationServiceException

Throws:

RecommendationServiceException

updateRecommendation

void updateRecommendation(String recommendationId,
                          int index,
                          boolean active,
                          String title,
                          String recommendationText,
                          Date creationDate,
                          Date expirationDate)
                   throws RecommendationServiceException

updates a recommendation

Parameters:

recommendationId - the id of the recommendation

recommendationText - the text of the recommendation

creationDate - the date the recommendation is created

expirationDate - the date the recommendation expires

Throws:

RecommendationServiceException - if the recommendation does not exist or cannot be updated

updateAnnouncement

void updateAnnouncement(String announcementId,
                        int index,
                        boolean active,
                        String announcementTitle,
                        String announcementText,
                        Date creationDate,
                        Date expirationDate)
                 throws RecommendationServiceException

updates an announcement and the corresponding recommendation

Parameters:

announcementId - the id of the announcement

recommendationText - the text of the corresponding recommendation

creationDate - the creation date of the announcement

expirationDate - the expiration date of the announcement

Throws:

RecommendationServiceException - if the announcement recommendation does not exist or cannot be updated

updateCommunityRecommendation

void updateCommunityRecommendation(String recommendationId,
                                   int index,
                                   boolean active,
                                   String title,
                                   String recommendationText,
                                   Date creationDate,
                                   Date expirationDate,
                                   Set<String> communityIds)
                            throws RecommendationServiceException

Throws:

RecommendationServiceException

addRecommendationToUser

void addRecommendationToUser(String recommendationId,
                             String userId)
                      throws RecommendationServiceException

Throws:

RecommendationServiceException

getCommunityRecommendationsForUser

List<String> getCommunityRecommendationsForUser(String userId)
                                         throws RecommendationServiceException

gets all the community recommendation for a specific user

Throws:

RecommendationServiceException

getCommunityRecommendationsForUserObj

List<eu.dnetlib.domain.functionality.Recommendation> getCommunityRecommendationsForUserObj(String userId)
                                                                                    throws RecommendationServiceException

gets all the community recommendation objects for a specific user

Throws:

RecommendationServiceException