org.ametys.plugins.survey.repository

Class SurveyAccessHelper

java.lang.Object

org.apache.avalon.framework.logger.AbstractLogEnabled

org.ametys.plugins.survey.repository.SurveyAccessHelper

All Implemented Interfaces:

Component, LogEnabled, Serviceable, ThreadSafe

public class SurveyAccessHelper
extends AbstractLogEnabled
implements Component, ThreadSafe, Serviceable

helper to check survey access

Field Summary

Fields

Modifier and Type	Field and Description
protected SurveyAnswerDao	_answerDao The ametys object resolver.
protected org.ametys.runtime.group.GroupsManager	_foGroupsManager The FO groups manager
static java.lang.String	ROLE Avalon role

Constructor Summary

Constructors

Constructor and Description
SurveyAccessHelper()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCookieName(Request request, java.lang.String surveyId) Return the name of cookie if the survey was already taken or null otherwise.
java.util.Date	getSubmissionDate(java.lang.String surveyId, java.lang.String login) Returns the date on which the user answered to the survey or null if he was never answered
boolean	isUserGranted(Survey survey, java.lang.String login) Test if the current user has the right to take the survey.
void	service(ServiceManager manager)

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled

enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object

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

Field Detail

ROLE

public static final java.lang.String ROLE

Avalon role

_foGroupsManager

protected org.ametys.runtime.group.GroupsManager _foGroupsManager

The FO groups manager

_answerDao

protected SurveyAnswerDao _answerDao

The ametys object resolver.

Constructor Detail

SurveyAccessHelper

public SurveyAccessHelper()

Method Detail

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

isUserGranted

public boolean isUserGranted(Survey survey,
                             java.lang.String login)

Test if the current user has the right to take the survey.

Parameters:

survey - the survey.

login - the user login.

Returns:

true if the user can take the survey (the survey isn't private or the user has an invitation), false otherwise.

getSubmissionDate

public java.util.Date getSubmissionDate(java.lang.String surveyId,
                                        java.lang.String login)

Returns the date on which the user answered to the survey or null if he was never answered

Parameters:

surveyId - the survey ID.

login - the user login.

Returns:

the date on which the survey was taken, or null if the user never took the survey.

getCookieName

public java.lang.String getCookieName(Request request,
                                      java.lang.String surveyId)

Return the name of cookie if the survey was already taken or null otherwise.

Parameters:

request - the request.

surveyId - the survey ID.

Returns:

the name of cookie if the survey was already taken, or null otherwise.