eu.dnetlib.api.functionality

Interface CommunityService

All Superinterfaces:

DriverService

public interface CommunityService
extends DriverService

The class that manages Community objects

Method Summary

Modifier and Type	Method and Description
void	deleteCommunity(eu.dnetlib.domain.functionality.Community community) Delete a community.
void	deleteCommunityById(String id) Delete a community.
eu.dnetlib.domain.functionality.Community	getCommunityById(String id) Search for a community by id
boolean	isManager(String communityId, String userId) Check if a user is manager of a community.
boolean	isOwner(String communityId, String userId) Check if a user is owner of a community.
eu.dnetlib.domain.functionality.Community	saveCommunity(eu.dnetlib.domain.functionality.Community community) Create or edit a community.
List<eu.dnetlib.domain.functionality.Community>	searchCommunities(eu.dnetlib.domain.functionality.CommunitySearchCriteria criteria) Search for communities by the specified criteria.
List<String>	searchCommunityIds(eu.dnetlib.domain.functionality.CommunitySearchCriteria criteria) Search for communities by the specified criteria.

Methods inherited from interface eu.dnetlib.api.DriverService

identify, notify

Method Detail

saveCommunity

eu.dnetlib.domain.functionality.Community saveCommunity(eu.dnetlib.domain.functionality.Community community)
                                                 throws CommunityServiceException

Create or edit a community.

Parameters:

community - the community to save

Returns:

the community just saved

Throws:

CommunityServiceException - if any errors occur

deleteCommunity

void deleteCommunity(eu.dnetlib.domain.functionality.Community community)
              throws CommunityServiceException

Delete a community.

Parameters:

community - the community to delete

Throws:

CommunityServiceException - if any errors occur

deleteCommunityById

void deleteCommunityById(String id)
                  throws CommunityServiceException

Delete a community.

Parameters:

id - the id of the community to delete

Throws:

CommunityServiceException - if any errors occur

getCommunityById

eu.dnetlib.domain.functionality.Community getCommunityById(String id)
                                                    throws CommunityServiceException

Search for a community by id

Parameters:

id - the id of the community to search for

Returns:

the community with the specified id or null if no such community exists

Throws:

CommunityServiceException

searchCommunities

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

Search for communities by the specified criteria.

Parameters:

criteria - the search criteria to match

Returns:

a list containing all the communities that match the specified criteria

Throws:

CommunityServiceException - if any errors occur

searchCommunityIds

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

Search for communities by the specified criteria.

Parameters:

criteria - the search criteria to match

Returns:

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

Throws:

CommunityServiceException - if any errors occur

isOwner

boolean isOwner(String communityId,
                String userId)
         throws CommunityServiceException

Check if a user is owner of a community.

Parameters:

communityId - the id of the community to check for

userId - the id of the user to check for

Returns:

true if the user is owner of the community; false otherwise

Throws:

CommunityServiceException - if any errors occur

isManager

boolean isManager(String communityId,
                  String userId)
           throws CommunityServiceException

Check if a user is manager of a community.

Parameters:

communityId - the id of the community to check for

userId - the id of the user to check for

Returns:

true if the user is manager of the community; false otherwise

Throws:

CommunityServiceException