StudyController (SeqWare 1.1.2 API)

java.lang.Object
- org.springframework.context.support.ApplicationObjectSupport
- - org.springframework.web.context.support.WebApplicationObjectSupport
  - - org.springframework.web.servlet.support.WebContentGenerator
    - - org.springframework.web.servlet.mvc.AbstractController
      - org.springframework.web.servlet.mvc.multiaction.MultiActionController
        
        net.sourceforge.solexatools.webapp.controller.StudyController

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.web.context.ServletContextAware, org.springframework.web.servlet.mvc.Controller, org.springframework.web.servlet.mvc.LastModified
```
public class StudyController
extends org.springframework.web.servlet.mvc.multiaction.MultiActionController
```
StudyController

Version:

$Id: $Id

Author:

boconnor

Field Summary
- Fields inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController
  DEFAULT_COMMAND_NAME, LAST_MODIFIED_METHOD_SUFFIX, PAGE_NOT_FOUND_LOG_CATEGORY, pageNotFoundLogger
- Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator
  METHOD_GET, METHOD_HEAD, METHOD_POST
- Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
  logger

Constructor Summary

Constructors
Constructor and Description

StudyController()
Constructor for StudyController.

StudyController(Object delegate)
Constructor for StudyController.

Constructors
Constructor and Description
`StudyController()` Constructor for StudyController.
`StudyController(Object delegate)` Constructor for StudyController.

Method Summary

Methods
Modifier and Type	Method and Description
`ShareStudyService`	`getShareStudyService()` Getter for the field `shareStudyService`.
`StudyService`	`getStudyService()` Getter for the field `studyService`.
`StudyTypeService`	`getStudyTypeService()` Getter for the field `studyTypeService`.
`org.springframework.validation.Validator`	`getUpdateValidator()` getUpdateValidator.
`org.springframework.validation.Validator`	`getValidator()` getValidator.
`org.springframework.web.servlet.ModelAndView`	`handleCancel(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Study command)` Handles the user's request to cancel the study or the study update page.
`org.springframework.web.servlet.ModelAndView`	`handleDelete(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Study command)` Handles the user's request to delete their study.
`org.springframework.web.servlet.ModelAndView`	`handleReset(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Study command)` Handles the user's request to reset the study page during a new or update study.
`org.springframework.web.servlet.ModelAndView`	`handleShare(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Study command)` Handles the user's request to share their study.
`org.springframework.web.servlet.ModelAndView`	`handleSubmit(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Study command)` Handles the user's request to submit a new study.
`org.springframework.web.servlet.ModelAndView`	`handleUpdate(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Study command)` Handles the user's request to update their study.
`void`	`setRegistrationService(RegistrationService registrationService)` Setter for the field `registrationService`.
`void`	`setShareStudyService(ShareStudyService shareStudyService)` Setter for the field `shareStudyService`.
`void`	`setStudyService(StudyService studyService)` Setter for the field `studyService`.
`void`	`setStudyTypeService(StudyTypeService studyTypeService)` Setter for the field `studyTypeService`.
`void`	`setUpdateValidator(org.springframework.validation.Validator validator)` setUpdateValidator.
`void`	`setValidator(org.springframework.validation.Validator validator)` setValidator.

Methods inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController
bind, createBinder, getCommandName, getExceptionHandler, getLastModified, getMethodNameResolver, getValidators, getWebBindingInitializer, handleNoSuchRequestHandlingMethod, handleRequestInternal, initBinder, invokeNamedMethod, newCommandObject, setDelegate, setMethodNameResolver, setValidators, setWebBindingInitializer

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController
handleRequest, isSynchronizeOnSession, setSynchronizeOnSession

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator
applyCacheSeconds, applyCacheSeconds, cacheForSeconds, cacheForSeconds, checkAndPrepare, checkAndPrepare, getCacheSeconds, getSupportedMethods, isAlwaysMustRevalidate, isRequireSession, isUseCacheControlHeader, isUseCacheControlNoStore, isUseExpiresHeader, preventCaching, setAlwaysMustRevalidate, setCacheSeconds, setRequireSession, setSupportedMethods, setUseCacheControlHeader, setUseCacheControlNoStore, setUseExpiresHeader

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, initApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- StudyController
```
public StudyController()
```
  Constructor for StudyController.
- StudyController
```
public StudyController(Object delegate)
```
  Constructor for StudyController.
  
  Parameters:
  delegate - a Object object.

Method Detail

getStudyService
```
public StudyService getStudyService()
```
Getter for the field studyService.

Returns:
a StudyService object.

setStudyService
```
public void setStudyService(StudyService studyService)
```
Setter for the field studyService.

Parameters:
studyService - a StudyService object.

getShareStudyService
```
public ShareStudyService getShareStudyService()
```
Getter for the field shareStudyService.

Returns:
a ShareStudyService object.

setShareStudyService
```
public void setShareStudyService(ShareStudyService shareStudyService)
```
Setter for the field shareStudyService.

Parameters:
shareStudyService - a ShareStudyService object.

setRegistrationService
```
public void setRegistrationService(RegistrationService registrationService)
```
Setter for the field registrationService.

Parameters:
registrationService - a RegistrationService object.

getValidator

public org.springframework.validation.Validator getValidator()

getValidator.

Returns:: a Validator object.

setValidator

public void setValidator(org.springframework.validation.Validator validator)

setValidator.

Parameters:: validator - a Validator object.

getUpdateValidator

public org.springframework.validation.Validator getUpdateValidator()

getUpdateValidator.

Returns:: a Validator object.

setUpdateValidator

public void setUpdateValidator(org.springframework.validation.Validator validator)

setUpdateValidator.

Parameters:: validator - a Validator object.

getStudyTypeService
```
public StudyTypeService getStudyTypeService()
```
Getter for the field studyTypeService.

Returns:
a StudyTypeService object.

setStudyTypeService
```
public void setStudyTypeService(StudyTypeService studyTypeService)
```
Setter for the field studyTypeService.

Parameters:
studyTypeService - a StudyTypeService object.

handleSubmit

public org.springframework.web.servlet.ModelAndView handleSubmit(javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response,
                                                        Study command)
                                                          throws Exception

Handles the user's request to submit a new study.

Parameters:: request - HttpServletRequest; response - HttpServletResponse; command - Study command object
Returns:: ModelAndView
Throws:: Exception - if any.

handleReset

public org.springframework.web.servlet.ModelAndView handleReset(javax.servlet.http.HttpServletRequest request,
                                                       javax.servlet.http.HttpServletResponse response,
                                                       Study command)
                                                         throws Exception

Handles the user's request to reset the study page during a new or update study.

Parameters:: command - Study command object; request - a HttpServletRequest object.; response - a HttpServletResponse object.
Returns:: a ModelAndView object.
Throws:: Exception - if any.

handleCancel

public org.springframework.web.servlet.ModelAndView handleCancel(javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response,
                                                        Study command)
                                                          throws Exception

Handles the user's request to cancel the study or the study update page.

Parameters:: command - Study command object; request - a HttpServletRequest object.; response - a HttpServletResponse object.
Returns:: a ModelAndView object.
Throws:: Exception - if any.

handleUpdate

public org.springframework.web.servlet.ModelAndView handleUpdate(javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response,
                                                        Study command)
                                                          throws Exception

Handles the user's request to update their study.

Parameters:: command - Study command object; request - a HttpServletRequest object.; response - a HttpServletResponse object.
Returns:: a ModelAndView object.
Throws:: Exception - if any.

handleDelete

public org.springframework.web.servlet.ModelAndView handleDelete(javax.servlet.http.HttpServletRequest request,
                                                        javax.servlet.http.HttpServletResponse response,
                                                        Study command)
                                                          throws Exception

Handles the user's request to delete their study.

Parameters:: command - Study command object; request - a HttpServletRequest object.; response - a HttpServletResponse object.
Returns:: a ModelAndView object.
Throws:: Exception - if any.

handleShare

public org.springframework.web.servlet.ModelAndView handleShare(javax.servlet.http.HttpServletRequest request,
                                                       javax.servlet.http.HttpServletResponse response,
                                                       Study command)
                                                         throws Exception

Handles the user's request to share their study.

Parameters:: command - Study command object; request - a HttpServletRequest object.; response - a HttpServletResponse object.
Returns:: a ModelAndView object.
Throws:: Exception - if any.

Class StudyController

Field Summary

Fields inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController

Fields inherited from class org.springframework.web.servlet.support.WebContentGenerator

Fields inherited from class org.springframework.context.support.ApplicationObjectSupport

Constructor Summary

Method Summary

Methods inherited from class org.springframework.web.servlet.mvc.multiaction.MultiActionController

Methods inherited from class org.springframework.web.servlet.mvc.AbstractController

Methods inherited from class org.springframework.web.servlet.support.WebContentGenerator

Methods inherited from class org.springframework.web.context.support.WebApplicationObjectSupport

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

Methods inherited from class java.lang.Object

Constructor Detail

StudyController

StudyController

Method Detail

getStudyService

setStudyService

getShareStudyService

setShareStudyService

setRegistrationService