fr.ifremer.coselmar.services.v1

Class QuestionsWebService

java.lang.Object

org.debux.webmotion.server.WebMotionController

fr.ifremer.coselmar.services.CoselmarWebServiceSupport

fr.ifremer.coselmar.services.v1.QuestionsWebService

All Implemented Interfaces:

CoselmarService

public class QuestionsWebService
extends CoselmarWebServiceSupport

Author:

ymartel

Field Summary

Fields

Modifier and Type	Field and Description
protected static List<String>	RESTRICTED_ACCESS_USERS

Fields inherited from class org.debux.webmotion.server.WebMotionController

contextable

Constructor Summary

Constructors

Constructor and Description
QuestionsWebService()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDocuments(String questionId, DocumentBean[] documents)
void	addQuestion(QuestionBean question)
protected void	checkIsClientAllowed(Question question, CoselmarUser currentUser)
protected void	checkIsParticipant(Question question, CoselmarUser currentUser)
void	deleteQuestion(String questionId)
protected List<Question>	getAllFilteredQuestions(CoselmarUser currentUser, QuestionSearchBean searchBean) Methods that retrieve all questions matching search filter (based on title, summary, themes, status, privacy), also depending of current user role permission : ADMIN and SUPERVISOR can access to all questions ; MEMBER can only access to all public questions (so, if filter is on private, it has no result) ; EXPERT can access to all private questions where he is participant or client and all public questions ; CLIENT can access to all questions where he is client.
protected List<Question>	getAllQuestions(CoselmarUser currentUser) Methods that retrieve all questions depending of current user role permission : ADMIN and SUPERVISOR can access to all questions ; MEMBER can access to all public questions ; EXPERT can access to all private questions where he is participant or client and all public questions ; CLIENT can access to all questions where he is client.
QuestionBean	getQuestion(String questionId)
List<QuestionBean>	getQuestions(QuestionSearchBean searchOption)
protected List<String>	getQuestionsFullId(List<String> questionShortIds)
List<String>	getThemes()
List<String>	getTypes()
protected Set<Document>	retrieveDocuments(Collection<DocumentBean> documentBeans)
protected Set<Question>	retrieveQuestions(Collection<QuestionBean> questionBeans)
protected Set<CoselmarUser>	retrieveUsers(Collection<UserBean> userBeans)
void	saveQuestion(QuestionBean question)

Methods inherited from class fr.ifremer.coselmar.services.CoselmarWebServiceSupport

checkAuthentication, checkUserAuthentication, commit, getCleanMail, getCoselmarServicesConfig, getCoselmarUserDao, getCoselmarUserGroupDao, getDocumentDao, getDocumentsService, getFullIdFromShort, getFullUserIdFromShort, getLocale, getNow, getPersistenceContext, getQuestionDao, getServicesContext, getShortIdFromFull, newService, rollback, setServicesContext

Methods inherited from class org.debux.webmotion.server.WebMotionController

getContext, renderAction, renderAtom, renderContent, renderContent, renderDownload, renderDownload, renderError, renderError, renderFailure, renderForward, renderForward, renderJSON, renderJSONP, renderLastPage, renderRedirect, renderRSS, renderStatus, renderStream, renderStream, renderStringTemplate, renderSuccess, renderTemplate, renderURL, renderView, renderXML, setContextable, toMap

Methods inherited from class java.lang.Object

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

Field Detail

RESTRICTED_ACCESS_USERS

protected static final List<String> RESTRICTED_ACCESS_USERS

Constructor Detail

QuestionsWebService

public QuestionsWebService()

Method Detail

addQuestion

public void addQuestion(QuestionBean question)
                 throws InvalidCredentialException,
                        UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

getQuestions

public List<QuestionBean> getQuestions(QuestionSearchBean searchOption)
                                throws InvalidCredentialException,
                                       UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

deleteQuestion

public void deleteQuestion(String questionId)
                    throws InvalidCredentialException,
                           UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

getQuestion

public QuestionBean getQuestion(String questionId)
                         throws InvalidCredentialException,
                                UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

addDocuments

public void addDocuments(String questionId,
                DocumentBean[] documents)
                  throws InvalidCredentialException,
                         UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

saveQuestion

public void saveQuestion(QuestionBean question)
                  throws InvalidCredentialException,
                         UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

getThemes

public List<String> getThemes()
                       throws InvalidCredentialException,
                              UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

getTypes

public List<String> getTypes()
                      throws InvalidCredentialException,
                             UnauthorizedException

Throws:

InvalidCredentialException

UnauthorizedException

checkIsParticipant

protected void checkIsParticipant(Question question,
                      CoselmarUser currentUser)
                           throws UnauthorizedException

Throws:

UnauthorizedException

checkIsClientAllowed

protected void checkIsClientAllowed(Question question,
                        CoselmarUser currentUser)
                             throws UnauthorizedException

Throws:

UnauthorizedException

retrieveUsers

protected Set<CoselmarUser> retrieveUsers(Collection<UserBean> userBeans)

retrieveQuestions

protected Set<Question> retrieveQuestions(Collection<QuestionBean> questionBeans)

retrieveDocuments

protected Set<Document> retrieveDocuments(Collection<DocumentBean> documentBeans)

getAllQuestions

protected List<Question> getAllQuestions(CoselmarUser currentUser)
                                  throws UnauthorizedException

Methods that retrieve all questions depending of current user role permission :

• ADMIN and SUPERVISOR can access to all questions ;
• MEMBER can access to all public questions ;
• EXPERT can access to all private questions where he is participant or client and all public questions ;
• CLIENT can access to all questions where he is client.

Parameters:

currentUser - : current user that make request

Returns:

list of all question user is authorized to access.

Throws:

UnauthorizedException

getAllFilteredQuestions

protected List<Question> getAllFilteredQuestions(CoselmarUser currentUser,
                                     QuestionSearchBean searchBean)
                                          throws UnauthorizedException

Methods that retrieve all questions matching search filter (based on title, summary, themes, status, privacy), also depending of current user role permission :

• ADMIN and SUPERVISOR can access to all questions ;
• MEMBER can only access to all public questions (so, if filter is on private, it has no result) ;
• EXPERT can access to all private questions where he is participant or client and all public questions ;
• CLIENT can access to all questions where he is client.

Parameters:

currentUser - : current user that make request

searchBean - : bean containing search param to filter result

Returns:

list of all question user is authorized to access.

Throws:

UnauthorizedException

getQuestionsFullId

protected List<String> getQuestionsFullId(List<String> questionShortIds)