org.torweg.pulse.component.survey
Class SurveyController

java.lang.Object
  org.torweg.pulse.bundle.Controller
      org.torweg.pulse.component.survey.SurveyController

All Implemented Interfaces:

Configurable<SurveyControllerConfiguration>

public class SurveyController
extends Controller
implements Configurable<SurveyControllerConfiguration>

Executes Surveys (according to their settings).

The following methods produce the output in form of a JAXB-able result:

• main: executeSurveyController(Bundle, ServiceRequest)
• if a SurveyProgress was processed: outputAfterProgressProcessing(SurveyProgress, SurveyControllerResult, Bundle, ServiceRequest, boolean)
  sub-routines for building a new SurveyProgress and processing the actual answering of a question:
  • builds a SurveyProgress if none could be retrieved from session and all the validation/checks have passed: buildActualSurveyProgress(Survey, User, SurveyToken)
  • processes the answering: answerCurrentQuestion(SurveyProgress, int, ServiceRequest)

Following methods are the sub-routines to perform the required checks according to the current Survey's settings:

• performChecks(Survey, SurveyControllerResult, ServiceRequest)
  • performDateChecks(Survey, SurveyControllerResult)
  • performUserChecks(Survey, SurveyControllerResult, ServiceRequest)
  • checkForRequiredRoles(Survey, User)
  • loadSurveyToken(ServiceRequest, Survey)

Following methods take care of the session-management of the current SurveyProgress:

• retrieveSurveyProgressFromSession(Long, Bundle, ServiceRequest)
• storeSurveyProgressToSession(SurveyProgress, Bundle, ServiceRequest)
• removeSurveyProgressFromSession(SurveyProgress, Bundle, ServiceRequest)

Following methods take care of loading and storing the required entities of the current SurveyProgress:

• loading:
  • loadSurvey(Long)
  • loadSurveyToken(ServiceRequest, Survey)
  • loadPossiblyStoredQuestionnaire(User, SurveyToken)
• storing:
  • storeQuestionnaire(SurveyProgress)

Following methods perform the extraction of (validated) request-parameters required for loading/building the current SurveyProgress:

• extractSurveyIdFromCommand(Command)
• extractValidatedQuestionIndexFromCommand(Command, SurveyProgress)

Version:

$Revision: 1914 $

Author:

Daniel Dietz

Nested Class Summary

Nested classes/interfaces inherited from class org.torweg.pulse.bundle.Controller

Controller.AlwaysRun

Constructor Summary

SurveyController()

Method Summary

SurveyControllerResult	executeSurveyController(Bundle bundle, ServiceRequest request) Processes a survey-request.
void	initialize(SurveyControllerConfiguration conf) Initialises the SurveyController with the given Configuration.

Methods inherited from class org.torweg.pulse.bundle.Controller

getAlwaysRun, isAlwaysRun, setAlwaysRun

Methods inherited from class java.lang.Object

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

Constructor Detail

SurveyController

public SurveyController()

Method Detail

executeSurveyController

@Action(value="executeSurveyController")
@Permission(value="executeSurveyController")
public final SurveyControllerResult executeSurveyController(Bundle bundle, ServiceRequest request)

Processes a survey-request.

The Survey which is to be processed is to be specified by surveyId.

Parameters:

bundle - the Bundle

request - the ServiceRequest

Returns:

a JAXB-able result-Object, precisely a SurveyControllerResult

initialize

public final void initialize(SurveyControllerConfiguration conf)

Initialises the SurveyController with the given Configuration.

Specified by:

initialize in interface Configurable<SurveyControllerConfiguration>

Parameters:

conf - the Configuration