eu.dnetlib.clients.functionality.forum.ws

Interface ForumWebService

All Superinterfaces:

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

All Known Implementing Classes:

ForumWebServiceImpl

public interface ForumWebService
extends DriverWebService<eu.dnetlib.api.functionality.ForumService>

This interface describes the available methods of a forum web service.

Author:

thanos@di.uoa.gr

Method Summary

Modifier and Type	Method and Description
void	deleteThread(long threadId) Delete an existing thread.
void	editThread(long threadId, String topic, List<eu.dnetlib.domain.functionality.Post> posts) Edit an existing thread.
long	openThread(String communityId, String userId, String topic) Open a new thread.
eu.dnetlib.domain.functionality.Thread	searchThread(long threadId) Search for an existing thread by id.
List<eu.dnetlib.domain.functionality.Thread>	searchThread(String communityId) Search for existing threads by community.

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

identify, notify, start

Method Detail

openThread

long openThread(String communityId,
                String userId,
                String topic)
         throws ForumWebServiceException

Open a new thread.

Parameters:

communityId - the id of the community that the thread belongs to

userId - the id of the user that opens the thread

topic - the topic of the thread

Returns:

the id of the thread just opened

Throws:

eu.dnetlib.api.functionality.ForumServiceException - if any errors occur

ForumWebServiceException

editThread

void editThread(long threadId,
                String topic,
                List<eu.dnetlib.domain.functionality.Post> posts)
         throws ForumWebServiceException

Edit an existing thread.

Parameters:

threadId - the id of the thread to edit

topic - the new topic of the thread

Throws:

eu.dnetlib.api.functionality.ForumServiceException - if any errors occur

ForumWebServiceException

deleteThread

void deleteThread(long threadId)
           throws ForumWebServiceException

Delete an existing thread.

Parameters:

threadId - the id of the thread to delete

Throws:

eu.dnetlib.api.functionality.ForumServiceException - if any errors occur

ForumWebServiceException

searchThread

eu.dnetlib.domain.functionality.Thread searchThread(long threadId)
                                             throws ForumWebServiceException

Search for an existing thread by id.

Parameters:

threadId - the id of the thread to search for

Returns:

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

Throws:

eu.dnetlib.api.functionality.ForumServiceException - if any errors occur

ForumWebServiceException

searchThread

List<eu.dnetlib.domain.functionality.Thread> searchThread(String communityId)
                                                   throws ForumWebServiceException

Search for existing threads by community.

Parameters:

communityId - the id of the community the threads belong to

Returns:

a list containing all the threads that belong to the specified community

Throws:

eu.dnetlib.api.functionality.ForumServiceException - if any errors occur

ForumWebServiceException