eu.dnetlib.clients.functionality.community.ws

Class CommunityWebServiceImpl

java.lang.Object

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

eu.dnetlib.clients.functionality.community.ws.CommunityWebServiceImpl

All Implemented Interfaces:

eu.dnetlib.api.DriverServiceEndpoint<eu.dnetlib.api.functionality.CommunityService>, CommunityWebService, DriverWebService<eu.dnetlib.api.functionality.CommunityService>, eu.dnetlib.common.rmi.BaseService

public class CommunityWebServiceImpl
extends BaseDriverWebService<eu.dnetlib.api.functionality.CommunityService>
implements CommunityWebService

This class implements a community web service using a community service.

Author:

thanos

Field Summary

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

service

Constructor Summary

Constructors

Constructor and Description
CommunityWebServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	addAuthoritativeDocument(String communityId, String documentId) Add an authoritative document to a community.
void	addCollection(String communityId, String collectionId) Add a collection to a community.
void	addManager(String communityId, String userId) Add a new user as community manager to this community.
void	addRecommendation(String communityId, String recommendationId) Add a recommendation to a community.
String	createCommunity(String name, String ownerId) Create a new community.
List<String>	getAllCommunityIds() Get all the available community ids.
Set<String>	getAuthoritativeDocuments(String communityId) Get all the authoritative documents of a community.
Set<String>	getCollections(String communityId) Get all the collections of a community.
eu.dnetlib.domain.functionality.Community	getCommunity(String id) Search a community by id.
Set<String>	getManagers(String communityId) Get all the users that are managers of a community.
Set<String>	getRecommendations(String communityId) Get all the recommendations of a community.
void	removeAuthoritativeDocument(String communityId, String documentId) Remove an authoritative document from a community.
void	removeCollection(String communityId, String collectionId) Remove a collection from a community.
void	removeCommunity(String id) Remove an existing community.
void	removeManager(String communityId, String userId) Remove a a user as community manager from a community.
void	removeRecommendation(String communityId, String recommendationId) Remove a recommendation from a community.
List<eu.dnetlib.domain.functionality.Community>	searchCommunities(eu.dnetlib.domain.functionality.CommunitySearchCriteria criteria) Search communities by criteria.
List<String>	searchCommunityIds(eu.dnetlib.domain.functionality.CommunitySearchCriteria criteria) Search community ids by criteria.
void	updateCommunity(String id, String name, String description, String owner, Set<String> managers, Set<String> collections, Set<String> recommendations, Set<String> authoritativeDocuments) Update an existing community.

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

CommunityWebServiceImpl

public CommunityWebServiceImpl()

Method Detail

addCollection

public void addCollection(String communityId,
                          String collectionId)
                   throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Add a collection to a community.

Specified by:

addCollection in interface CommunityWebService

Parameters:

communityId - the id of the community

collectionId - the id of the collection

Throws:

CommunityWebServiceException - if any errors occur

addManager

public void addManager(String communityId,
                       String userId)
                throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Add a new user as community manager to this community.

Specified by:

addManager in interface CommunityWebService

Parameters:

communityId - the id of the community

userId - the id of the user

Throws:

CommunityWebServiceException - if any errors occur

addRecommendation

public void addRecommendation(String communityId,
                              String recommendationId)
                       throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Add a recommendation to a community.

Specified by:

addRecommendation in interface CommunityWebService

Parameters:

communityId - the id of the community

recommendationId - the id of the recommendation

Throws:

CommunityWebServiceException - if any errors occur

createCommunity

public String createCommunity(String name,
                              String ownerId)
                       throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Create a new community.

Specified by:

createCommunity in interface CommunityWebService

Parameters:

name - the community name

ownerId - the id of the user that owns the community

Returns:

the id of the newly created community

Throws:

CommunityWebServiceException - if any errors occur

getAllCommunityIds

public List<String> getAllCommunityIds()
                                throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Get all the available community ids.

Specified by:

getAllCommunityIds in interface CommunityWebService

Returns:

a list containing all the available community ids

Throws:

CommunityWebServiceException

getCollections

public Set<String> getCollections(String communityId)
                           throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Get all the collections of a community.

Specified by:

getCollections in interface CommunityWebService

Parameters:

communityId - the id of the community

Returns:

a set containing the ids of all the collections of the specified community

Throws:

CommunityWebServiceException - if any errors occur

getCommunity

public eu.dnetlib.domain.functionality.Community getCommunity(String id)
                                                       throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Search a community by id.

Specified by:

getCommunity in interface CommunityWebService

Parameters:

id - the id to search for

Returns:

the community that corresponds to the specified id or null if no such community exists

Throws:

CommunityWebServiceException - if any errors occur

getManagers

public Set<String> getManagers(String communityId)
                        throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Get all the users that are managers of a community.

Specified by:

getManagers in interface CommunityWebService

Parameters:

communityId - the id of the community

Returns:

a set containing the ids of all the users that are managers of this community

Throws:

CommunityWebServiceException - if any errors occur

getRecommendations

public Set<String> getRecommendations(String communityId)
                               throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Get all the recommendations of a community.

Specified by:

getRecommendations in interface CommunityWebService

Parameters:

communityId - the id of the community

Returns:

a set containing the ids of all the recommendations of the specified community

Throws:

CommunityWebServiceException - if any errors occur

removeCollection

public void removeCollection(String communityId,
                             String collectionId)
                      throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Remove a collection from a community.

Specified by:

removeCollection in interface CommunityWebService

Parameters:

communityId - the id of the community

collectionId - the id of the collection

Throws:

CommunityWebServiceException - if any errors occur

removeCommunity

public void removeCommunity(String id)
                     throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Remove an existing community.

Specified by:

removeCommunity in interface CommunityWebService

Parameters:

id - the id of the community to remove

Throws:

CommunityWebServiceException - if any errors occur

removeManager

public void removeManager(String communityId,
                          String userId)
                   throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Remove a a user as community manager from a community.

Specified by:

removeManager in interface CommunityWebService

Parameters:

communityId - the id of the community

userId - the id of the user

Throws:

CommunityWebServiceException - if any errors occur

removeRecommendation

public void removeRecommendation(String communityId,
                                 String recommendationId)
                          throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Remove a recommendation from a community.

Specified by:

removeRecommendation in interface CommunityWebService

Parameters:

communityId - the id of the community

recommendationId - the id of the recommendation

Throws:

CommunityWebServiceException - if any errors occur

updateCommunity

public void updateCommunity(String id,
                            String name,
                            String description,
                            String owner,
                            Set<String> managers,
                            Set<String> collections,
                            Set<String> recommendations,
                            Set<String> authoritativeDocuments)
                     throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Update an existing community.

Specified by:

updateCommunity in interface CommunityWebService

Parameters:

id - the id of the community to update

name - the new community name

description - the new community description

owner - the new owner of the community

managers - the new set of community managers

collections - the new set of community collections

recommendations - the new set of community recommendations

authoritativeDocuments - the new set of community authoritative documents

Throws:

CommunityWebServiceException - if any errors occur

searchCommunities

public List<eu.dnetlib.domain.functionality.Community> searchCommunities(eu.dnetlib.domain.functionality.CommunitySearchCriteria criteria)
                                                                  throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Search communities by criteria.

Specified by:

searchCommunities in interface CommunityWebService

Parameters:

criteria - the criteria to search for

Returns:

a list containing all the communities that match the specified criteria

Throws:

CommunityWebServiceException - if any errors occur

searchCommunityIds

public List<String> searchCommunityIds(eu.dnetlib.domain.functionality.CommunitySearchCriteria criteria)
                                throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Search community ids by criteria.

Specified by:

searchCommunityIds in interface CommunityWebService

Parameters:

criteria - the criteria to search for

Returns:

a list containing the ids of all the communities that match the specified criteria

Throws:

CommunityWebServiceException - if any errors occur

addAuthoritativeDocument

public void addAuthoritativeDocument(String communityId,
                                     String documentId)
                              throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Add an authoritative document to a community.

Specified by:

addAuthoritativeDocument in interface CommunityWebService

Parameters:

communityId - the id of the community

documentId - the id of the authoritative document

Throws:

CommunityWebServiceException - if any errors occur

getAuthoritativeDocuments

public Set<String> getAuthoritativeDocuments(String communityId)
                                      throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Get all the authoritative documents of a community.

Specified by:

getAuthoritativeDocuments in interface CommunityWebService

Parameters:

communityId - the id of the community

Returns:

a set containing the ids of all the authoritative documents

Throws:

CommunityWebServiceException - if any errors occur

removeAuthoritativeDocument

public void removeAuthoritativeDocument(String communityId,
                                        String documentId)
                                 throws CommunityWebServiceException

Description copied from interface: CommunityWebService

Remove an authoritative document from a community.

Specified by:

removeAuthoritativeDocument in interface CommunityWebService

Parameters:

communityId - the id of the community

documentId - the id of the authoritative document

Throws:

CommunityWebServiceException - if any errors occur