Package org.openforis.collect.web.controller

Class SurveyController

java.lang.Object

org.openforis.collect.web.controller.BasicController

org.openforis.collect.web.controller.SurveyController

@Controller
@RequestMapping("/api/survey")
@Scope("session")
@Transactional(readOnly=true,
               propagation=SUPPORTS)
public class SurveyController
extends BasicController

Author:

S. Ricci

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SurveyController.SurveyCloneJob
static class	SurveyController.SurveyCloneParameters
static class	SurveyController.SurveyCreationParameters
static class	SurveyController.SurveyExportParameters
static class	SurveyController.SurveyImportJobView
static class	SurveyController.SurveyImportParameters
class	SurveyController.SurveyPublishResult

Constructor Summary

Constructors

Constructor	Description
SurveyController()

Method Summary

Modifier and Type	Method	Description
SurveyView	archiveSurvey(int id, String langCode)
SurveySummary	changeSurveyUserGroup(String surveyName, int userGroupId)
org.openforis.commons.web.Response	cloneIntoTemporarySurvey(int surveyId)
CollectJobController.JobView	cloneSurvey(@Valid SurveyController.SurveyCloneParameters params)
SurveyView	closeSurvey(int id, String langCode)
org.openforis.commons.web.Response	createSurvey(@Valid SurveyController.SurveyCreationParameters params, org.springframework.validation.BindingResult bindingResult)
org.openforis.commons.web.Response	deleteSurvey(int id)
void	downloadExportResult(javax.servlet.http.HttpServletResponse response)
org.openforis.commons.web.Response	getClonedSurveyId()
SurveyController.SurveyImportJobView	getSurveyImportStatus()
protected void	initBinder(org.springframework.web.bind.WebDataBinder binder)
SurveyView	loadSurvey(int id, boolean includeCodeListValues, String langCode)
List<SurveyFileView>	loadSurveyFiles(int surveyId)
List<?>	loadSurveys(Integer userId, Integer groupId, boolean fullSurveys, boolean includeCodeListValues, boolean includeTemporary, String langCode)
org.openforis.commons.web.Response	prepareSurveyImport(org.springframework.web.multipart.MultipartFile multipartFile)
SurveyController.SurveyPublishResult	publishSurvey(int id, boolean ignoreWarnings, String langCode)
CollectJobController.JobView	startExport(@Valid SurveyController.SurveyExportParameters params, org.springframework.validation.BindingResult result)
org.openforis.commons.web.Response	startSurveyFileImport(@Valid SurveyController.SurveyImportParameters params, org.springframework.validation.BindingResult bindingResult)
SurveyView	unpublishSurvey(int id, String langCode)
org.openforis.commons.web.Response	validateSurveyCloneParameters(@Valid SurveyController.SurveyCloneParameters params, org.springframework.validation.BindingResult result)
org.openforis.commons.web.Response	validateSurveyCreationParameters(@Valid SurveyController.SurveyCreationParameters params, org.springframework.validation.BindingResult result)
org.openforis.commons.web.Response	validateSurveyImportParameters(@Valid SurveyController.SurveyImportParameters params, org.springframework.validation.BindingResult result)

Methods inherited from class org.openforis.collect.web.controller.BasicController

generateFormValidationResponse, getSessionState

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

initBinder

@InitBinder
protected void initBinder(org.springframework.web.bind.WebDataBinder binder)

loadSurveys

@RequestMapping(method=GET)
@Transactional(readOnly=true,
               propagation=REQUIRED)
@ResponseBody
public List<?> loadSurveys(@RequestParam(value="userId",required=false)
                           Integer userId,
                           @RequestParam(value="groupId",required=false)
                           Integer groupId,
                           @RequestParam(value="full",required=false)
                           boolean fullSurveys,
                           @RequestParam(value="includeCodeListValues",required=false)
                           boolean includeCodeListValues,
                           @RequestParam(value="includeTemporary",required=false)
                           boolean includeTemporary,
                           @RequestParam(value="langCode",required=false,defaultValue="en")
                           String langCode)
                    throws Exception

Throws:

Exception

loadSurvey

@RequestMapping(value="{id}",
                method=GET)
@ResponseBody
public SurveyView loadSurvey(@PathVariable
                             int id,
                             @RequestParam(value="includeCodeListValues",required=false,defaultValue="true")
                             boolean includeCodeListValues,
                             @RequestParam(value="langCode",required=false,defaultValue="en")
                             String langCode)
                      throws Exception

Throws:

Exception

loadSurveyFiles

@RequestMapping(value="files/{surveyId}",
                method=GET)
@ResponseBody
public List<SurveyFileView> loadSurveyFiles(@PathVariable
                                            int surveyId)
                                     throws Exception

Throws:

Exception

createSurvey

@RequestMapping(method=POST)
@Transactional(readOnly=false,
               propagation=REQUIRED)
@ResponseBody
public org.openforis.commons.web.Response createSurvey(@Valid
                                                       @Valid SurveyController.SurveyCreationParameters params,
                                                       org.springframework.validation.BindingResult bindingResult)
                                                throws Exception

Throws:

Exception

cloneIntoTemporarySurvey

@RequestMapping(value="cloneintotemporary/{surveyId}",
                method=POST)
@Transactional(readOnly=false,
               propagation=REQUIRED)
@ResponseBody
public org.openforis.commons.web.Response cloneIntoTemporarySurvey(@PathVariable
                                                                   int surveyId)
                                                            throws Exception

Throws:

Exception

validateSurveyCreationParameters

@RequestMapping(value="validatecreation",
                method=POST)
@ResponseBody
public org.openforis.commons.web.Response validateSurveyCreationParameters(@Valid
                                                                           @Valid SurveyController.SurveyCreationParameters params,
                                                                           org.springframework.validation.BindingResult result)

publishSurvey

@RequestMapping(value="publish/{id}",
                method=POST)
@Transactional(readOnly=false,
               propagation=REQUIRED)
@ResponseBody
public SurveyController.SurveyPublishResult publishSurvey(@PathVariable
                                                          int id,
                                                          @RequestParam
                                                          boolean ignoreWarnings,
                                                          @RequestParam(value="langCode",required=false,defaultValue="en")
                                                          String langCode)
                                                   throws SurveyImportException

Throws:

SurveyImportException

unpublishSurvey

@RequestMapping(value="unpublish/{id}",
                method=POST)
@Transactional(readOnly=false,
               propagation=REQUIRED)
@ResponseBody
public SurveyView unpublishSurvey(@PathVariable
                                  int id,
                                  @RequestParam(value="langCode",required=false,defaultValue="en")
                                  String langCode)
                           throws SurveyStoreException

Throws:

SurveyStoreException

closeSurvey

@RequestMapping(value="close/{id}",
                method=POST)
@Transactional(readOnly=false,
               propagation=REQUIRED)
@ResponseBody
public SurveyView closeSurvey(@PathVariable
                              int id,
                              @RequestParam(value="langCode",required=false,defaultValue="en")
                              String langCode)
                       throws SurveyImportException

Throws:

SurveyImportException

archiveSurvey

@RequestMapping(value="archive/{id}",
                method=POST)
@Transactional(readOnly=false,
               propagation=REQUIRED)
@ResponseBody
public SurveyView archiveSurvey(@PathVariable
                                int id,
                                @RequestParam(value="langCode",required=false,defaultValue="en")
                                String langCode)
                         throws SurveyImportException

Throws:

SurveyImportException

deleteSurvey

@RequestMapping(value="delete/{id}",
                method=POST)
@Transactional(readOnly=false,
               propagation=REQUIRED)
@ResponseBody
public org.openforis.commons.web.Response deleteSurvey(@PathVariable
                                                       int id)
                                                throws SurveyImportException

Throws:

SurveyImportException

cloneSurvey

@RequestMapping(value="clone",
                method=POST)
@Transactional(readOnly=false,
               propagation=REQUIRED)
@ResponseBody
public CollectJobController.JobView cloneSurvey(@Valid
                                                @Valid SurveyController.SurveyCloneParameters params)

getClonedSurveyId

@RequestMapping(value="cloned/id",
                method=GET)
@ResponseBody
public org.openforis.commons.web.Response getClonedSurveyId()

validateSurveyCloneParameters

@RequestMapping(value="validate/clone",
                method=POST)
@ResponseBody
public org.openforis.commons.web.Response validateSurveyCloneParameters(@Valid
                                                                        @Valid SurveyController.SurveyCloneParameters params,
                                                                        org.springframework.validation.BindingResult result)

prepareSurveyImport

@RequestMapping(value="prepareimport",
                method=POST,
                consumes="multipart/form-data")
@ResponseBody
public org.openforis.commons.web.Response prepareSurveyImport(@RequestParam("file")
                                                              org.springframework.web.multipart.MultipartFile multipartFile)

validateSurveyImportParameters

@RequestMapping(value="validateimport",
                method=POST)
@ResponseBody
public org.openforis.commons.web.Response validateSurveyImportParameters(@Valid
                                                                         @Valid SurveyController.SurveyImportParameters params,
                                                                         org.springframework.validation.BindingResult result)

startSurveyFileImport

@RequestMapping(value="startimport",
                method=POST)
@ResponseBody
public org.openforis.commons.web.Response startSurveyFileImport(@Valid
                                                                @Valid SurveyController.SurveyImportParameters params,
                                                                org.springframework.validation.BindingResult bindingResult)

getSurveyImportStatus

@RequestMapping(value="importstatus",
                method=GET)
@ResponseBody
public SurveyController.SurveyImportJobView getSurveyImportStatus()

changeSurveyUserGroup

@RequestMapping(value="{surveyName}/changeusergroup",
                method=POST)
@Transactional(readOnly=false,
               propagation=REQUIRED)
@ResponseBody
public SurveySummary changeSurveyUserGroup(@PathVariable
                                           String surveyName,
                                           @RequestParam
                                           int userGroupId)
                                    throws SurveyStoreException

Throws:

SurveyStoreException

startExport

@RequestMapping(value="export/{id}",
                method=POST)
@ResponseBody
public CollectJobController.JobView startExport(@Valid
                                                @Valid SurveyController.SurveyExportParameters params,
                                                org.springframework.validation.BindingResult result)

downloadExportResult

@RequestMapping(value="export/{surveyId}/result",
                method=GET)
public void downloadExportResult(javax.servlet.http.HttpServletResponse response)
                          throws FileNotFoundException,
                                 IOException

Throws:

FileNotFoundException

IOException