eu.dnetlib.clients.functionality.recommendation.ws

Class RecommendationWebServiceImpl

java.lang.Object

eu.dnetlib.clients.ws.BaseDriverWebService<eu.dnetlib.api.functionality.RecommendationService>

eu.dnetlib.clients.functionality.recommendation.ws.RecommendationWebServiceImpl

All Implemented Interfaces:

eu.dnetlib.api.DriverServiceEndpoint<eu.dnetlib.api.functionality.RecommendationService>, RecommendationWebService, DriverWebService<eu.dnetlib.api.functionality.RecommendationService>, eu.dnetlib.common.rmi.BaseService

public class RecommendationWebServiceImpl
extends BaseDriverWebService<eu.dnetlib.api.functionality.RecommendationService>
implements RecommendationWebService

Field Summary

Fields inherited from class eu.dnetlib.clients.ws.BaseDriverWebService

service

Constructor Summary

Constructors

Constructor and Description
RecommendationWebServiceImpl()

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, just the content
List<String>	getAllCommunityRecommendations(String communityId) retrieves all community recommendations that are associated with a community
List<eu.dnetlib.domain.functionality.Recommendation>	getAllCommunityRecommendationsObj() retrieves all recommendations Objects, not just the content of type community
List<eu.dnetlib.domain.functionality.Recommendation>	getAllCommunityRecommendationsObj(String communityId)
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	sendAnnouncement(String announcementId) sends an e-mail to all users with the recommendation text of an announcement
void	swapAnnouncements(String announcementId1, String announcementId2) Swap the index of 2 announcements
void	swapCommunityRecommendations(String communityId1, String communityId2)
void	swapUserRecommendations(String recommendationId1, String recommendationId2)
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 announcementTitle, String recommendationText, Date creationDate, Date expirationDate, Set<String> communityIds)
void	updateRecommendation(String recommendationId, int index, boolean active, String announcementTitle, String recommendationText, Date creationDate, Date expirationDate) updates a recommendation

Methods inherited from class eu.dnetlib.clients.ws.BaseDriverWebService

identify, notify, setService, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.dnetlib.common.rmi.BaseService

identify, notify, start

Constructor Detail

RecommendationWebServiceImpl

public RecommendationWebServiceImpl()

Method Detail

addRecommendationToUser

public void addRecommendationToUser(String recommendationId,
                                    String userId)
                             throws RecommendationWebServiceException

Specified by:

addRecommendationToUser in interface RecommendationWebService

Throws:

RecommendationWebServiceException

generateAnnouncement

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

Description copied from interface: RecommendationWebService

creates a new recommendation of type announcement

Specified by:

generateAnnouncement in interface RecommendationWebService

creationDate - the creation date of the announcement

expirationDate - the date the announcement expires

Returns:

the id of the new recommendation

Throws:

RecommendationWebServiceException

generateCommunityRecommendation

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

Description copied from interface: RecommendationWebService

creates a new recommendation of type community

Specified by:

generateCommunityRecommendation in interface RecommendationWebService

recommendationText - the recommendation text

Returns:

the id of the recommendation

Throws:

RecommendationWebServiceException - if the community recommendation cannot be created

generateRecommendation

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

Description copied from interface: RecommendationWebService

creates a new recommendation

Specified by:

generateRecommendation in interface RecommendationWebService

creationDate - the date the recommendation was created

expirationDate - the date the recommendation expires

Returns:

the id of the recommendation

Throws:

RecommendationWebServiceException - if the recommendation cannot be created

generateUserRecommendation

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

Description copied from interface: RecommendationWebService

creates a new recommendation of type user

Specified by:

generateUserRecommendation in interface RecommendationWebService

Returns:

the id of the recommendation

Throws:

RecommendationWebServiceException - if the user recommendation cannot be created

getAllAnnouncementIds

public List<String> getAllAnnouncementIds()
                                   throws eu.dnetlib.api.functionality.RecommendationServiceException

Description copied from interface: RecommendationWebService

retrieves ths ids of all announcements

Specified by:

getAllAnnouncementIds in interface RecommendationWebService

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getAllAnnouncements

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

Description copied from interface: RecommendationWebService

retrieves the recommendation text of all announcements

Specified by:

getAllAnnouncements in interface RecommendationWebService

Returns:

the recommendation text of all announcements

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getAllCommunityRecommendations

public List<String> getAllCommunityRecommendations()
                                            throws eu.dnetlib.api.functionality.RecommendationServiceException

Description copied from interface: RecommendationWebService

retrieves all recommendations of type community, just the content

Specified by:

getAllCommunityRecommendations in interface RecommendationWebService

Returns:

the recommendation text of all community recommendations

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getAllCommunityRecommendationsObj

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

Description copied from interface: RecommendationWebService

retrieves all recommendations Objects, not just the content of type community

Specified by:

getAllCommunityRecommendationsObj in interface RecommendationWebService

Returns:

the recommendation text of all community recommendations

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getAllCommunityRecommendations

public List<String> getAllCommunityRecommendations(String communityId)
                                            throws eu.dnetlib.api.functionality.RecommendationServiceException

Description copied from interface: RecommendationWebService

retrieves all community recommendations that are associated with a community

Specified by:

getAllCommunityRecommendations in interface RecommendationWebService

Parameters:

communityId - the id of the community

Returns:

the recommendation text of the community recommendations

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getAllCommunityRecommendationsObj

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

Specified by:

getAllCommunityRecommendationsObj in interface RecommendationWebService

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getAllUserRecommendations

public List<String> getAllUserRecommendations(String userId)
                                       throws eu.dnetlib.api.functionality.RecommendationServiceException

Specified by:

getAllUserRecommendations in interface RecommendationWebService

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getAnnouncements

public List<String> getAnnouncements()
                              throws eu.dnetlib.api.functionality.RecommendationServiceException

Description copied from interface: RecommendationWebService

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

Specified by:

getAnnouncements in interface RecommendationWebService

Returns:

the announcements' recommendation text

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getCommunityRecommendations

public List<String> getCommunityRecommendations(String communityId)
                                         throws eu.dnetlib.api.functionality.RecommendationServiceException

Specified by:

getCommunityRecommendations in interface RecommendationWebService

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getCommunityRecommendationsObj

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

Specified by:

getCommunityRecommendationsObj in interface RecommendationWebService

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getCommunityRecommendationsForUser

public List<String> getCommunityRecommendationsForUser(String userId)
                                                throws eu.dnetlib.api.functionality.RecommendationServiceException

Description copied from interface: RecommendationWebService

gets all the community recommendation for a specific user

Specified by:

getCommunityRecommendationsForUser in interface RecommendationWebService

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getCommunityRecommendationsForUserObj

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

Description copied from interface: RecommendationWebService

gets all the community recommendation objects for a specific user

Specified by:

getCommunityRecommendationsForUserObj in interface RecommendationWebService

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getRecommendation

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

Description copied from interface: RecommendationWebService

retrieves a recommendation

Specified by:

getRecommendation in interface RecommendationWebService

Parameters:

recommendationId - the recommendation id

Returns:

the recommendation or null if the recommendation does not exist

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getRecommendationText

public String getRecommendationText(String recommendationId)
                             throws eu.dnetlib.api.functionality.RecommendationServiceException

Description copied from interface: RecommendationWebService

retrieves the text of a recommendation

Specified by:

getRecommendationText in interface RecommendationWebService

Parameters:

recommendationId - the id of the recommendation

Returns:

the recommendation text or null if the recommendation does not exist

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

getRecommendations

public List<String> getRecommendations(List<String> recommendationIds)
                                throws eu.dnetlib.api.functionality.RecommendationServiceException

Description copied from interface: RecommendationWebService

retrieves the recommendation text of a Set of recommendations

Specified by:

getRecommendations in interface RecommendationWebService

Parameters:

recommendationIds - the ids of the recommendations

Returns:

a Set of the recommendations' text

Throws:

eu.dnetlib.api.functionality.RecommendationServiceException

removeAnnouncement

public void removeAnnouncement(String announcementId)
                        throws RecommendationWebServiceException

Description copied from interface: RecommendationWebService

removes a recommendation of type announcement

Specified by:

removeAnnouncement in interface RecommendationWebService

Parameters:

announcementId - the id of the announcement

Throws:

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

removeCommunityRecommendation

public void removeCommunityRecommendation(String recommendationId)
                                   throws RecommendationWebServiceException

Description copied from interface: RecommendationWebService

removes a recommendation of type community

Specified by:

removeCommunityRecommendation in interface RecommendationWebService

Parameters:

recommendationId - the id of the recommendation

Throws:

RecommendationWebServiceException

removeRecommendation

public void removeRecommendation(String recommendationId)
                          throws RecommendationWebServiceException

Description copied from interface: RecommendationWebService

removes a recommendation

Specified by:

removeRecommendation in interface RecommendationWebService

Parameters:

recommendationId - the id of the recommendation

Throws:

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

removeUserRecommendation

public void removeUserRecommendation(String recommendationId)
                              throws RecommendationWebServiceException

Specified by:

removeUserRecommendation in interface RecommendationWebService

Throws:

RecommendationWebServiceException

sendAnnouncement

public void sendAnnouncement(String announcementId)
                      throws RecommendationWebServiceException

Description copied from interface: RecommendationWebService

sends an e-mail to all users with the recommendation text of an announcement

Specified by:

sendAnnouncement in interface RecommendationWebService

Parameters:

announcementId - the id of the announcement

Throws:

RecommendationWebServiceException - if the announcement or recommendation does not exist

updateAnnouncement

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

Description copied from interface: RecommendationWebService

updates an announcement and the corresponding recommendation

Specified by:

updateAnnouncement in interface RecommendationWebService

Parameters:

announcementId - the id of the announcement

creationDate - the creation date of the announcement

expirationDate - the expiration date of the announcement

Throws:

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

updateCommunityRecommendation

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

Specified by:

updateCommunityRecommendation in interface RecommendationWebService

Throws:

RecommendationWebServiceException

updateRecommendation

public void updateRecommendation(String recommendationId,
                                 int index,
                                 boolean active,
                                 String announcementTitle,
                                 String recommendationText,
                                 Date creationDate,
                                 Date expirationDate)
                          throws RecommendationWebServiceException

Description copied from interface: RecommendationWebService

updates a recommendation

Specified by:

updateRecommendation in interface RecommendationWebService

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:

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

swapAnnouncements

public void swapAnnouncements(String announcementId1,
                              String announcementId2)
                       throws RecommendationWebServiceException

Description copied from interface: RecommendationWebService

Swap the index of 2 announcements

Specified by:

swapAnnouncements in interface RecommendationWebService

Parameters:

announcementId1 - the id of the fist announcement

announcementId2 - the id of the second announcement

Throws:

RecommendationWebServiceException

swapCommunityRecommendations

public void swapCommunityRecommendations(String communityId1,
                                         String communityId2)
                                  throws RecommendationWebServiceException

Specified by:

swapCommunityRecommendations in interface RecommendationWebService

Throws:

RecommendationWebServiceException

swapUserRecommendations

public void swapUserRecommendations(String recommendationId1,
                                    String recommendationId2)
                             throws RecommendationWebServiceException

Specified by:

swapUserRecommendations in interface RecommendationWebService

Throws:

RecommendationWebServiceException