eu.dnetlib.clients.functionality.community.ws

Interface CommunityWebService

All Superinterfaces:

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

All Known Implementing Classes:

CommunityWebServiceImpl

public interface CommunityWebService
extends DriverWebService<eu.dnetlib.api.functionality.CommunityService>

This interface describes the methods available for a community web service.

Author:

thanos@di.uoa.gr

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 interface eu.dnetlib.common.rmi.BaseService

identify, notify, start

Method Detail

createCommunity

String createCommunity(String name,
                       String ownerId)
                throws CommunityWebServiceException

Create a new community.

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

updateCommunity

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

Update an existing community.

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

removeCommunity

void removeCommunity(String id)
              throws CommunityWebServiceException

Remove an existing community.

Parameters:

id - the id of the community to remove

Throws:

CommunityWebServiceException - if any errors occur

getCommunity

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

Search a community by id.

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

getAllCommunityIds

List<String> getAllCommunityIds()
                         throws CommunityWebServiceException

Get all the available community ids.

Returns:

a list containing all the available community ids

Throws:

CommunityWebServiceException

searchCommunities

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

Search communities by criteria.

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

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

Search community ids by criteria.

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

addCollection

void addCollection(String communityId,
                   String collectionId)
            throws CommunityWebServiceException

Add a collection to a community.

Parameters:

communityId - the id of the community

collectionId - the id of the collection

Throws:

CommunityWebServiceException - if any errors occur

removeCollection

void removeCollection(String communityId,
                      String collectionId)
               throws CommunityWebServiceException

Remove a collection from a community.

Parameters:

communityId - the id of the community

collectionId - the id of the collection

Throws:

CommunityWebServiceException - if any errors occur

getCollections

Set<String> getCollections(String communityId)
                    throws CommunityWebServiceException

Get all the collections of a community.

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

addManager

void addManager(String communityId,
                String userId)
         throws CommunityWebServiceException

Add a new user as community manager to this community.

Parameters:

communityId - the id of the community

userId - the id of the user

Throws:

CommunityWebServiceException - if any errors occur

removeManager

void removeManager(String communityId,
                   String userId)
            throws CommunityWebServiceException

Remove a a user as community manager from a community.

Parameters:

communityId - the id of the community

userId - the id of the user

Throws:

CommunityWebServiceException - if any errors occur

getManagers

Set<String> getManagers(String communityId)
                 throws CommunityWebServiceException

Get all the users that are managers of a community.

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

addRecommendation

void addRecommendation(String communityId,
                       String recommendationId)
                throws CommunityWebServiceException

Add a recommendation to a community.

Parameters:

communityId - the id of the community

recommendationId - the id of the recommendation

Throws:

CommunityWebServiceException - if any errors occur

removeRecommendation

void removeRecommendation(String communityId,
                          String recommendationId)
                   throws CommunityWebServiceException

Remove a recommendation from a community.

Parameters:

communityId - the id of the community

recommendationId - the id of the recommendation

Throws:

CommunityWebServiceException - if any errors occur

getRecommendations

Set<String> getRecommendations(String communityId)
                        throws CommunityWebServiceException

Get all the recommendations of a community.

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

addAuthoritativeDocument

void addAuthoritativeDocument(String communityId,
                              String documentId)
                       throws CommunityWebServiceException

Add an authoritative document to a community.

Parameters:

communityId - the id of the community

documentId - the id of the authoritative document

Throws:

CommunityWebServiceException - if any errors occur

removeAuthoritativeDocument

void removeAuthoritativeDocument(String communityId,
                                 String documentId)
                          throws CommunityWebServiceException

Remove an authoritative document from a community.

Parameters:

communityId - the id of the community

documentId - the id of the authoritative document

Throws:

CommunityWebServiceException - if any errors occur

getAuthoritativeDocuments

Set<String> getAuthoritativeDocuments(String communityId)
                               throws CommunityWebServiceException

Get all the authoritative documents of a community.

Parameters:

communityId - the id of the community

Returns:

a set containing the ids of all the authoritative documents

Throws:

CommunityWebServiceException - if any errors occur