org.molgenis.studymanager

Class StudyManagerController

java.lang.Object

org.molgenis.framework.ui.MolgenisPluginController

org.molgenis.studymanager.StudyManagerController

@Controller
@RequestMapping(value="/plugin/studymanager")
public class StudyManagerController
extends MolgenisPluginController

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StudyManagerController.StudyDefinitionsMetaResponse
static class	StudyManagerController.StudyDefinitionUpdateRequest

Field Summary

Fields

Modifier and Type	Field and Description
static String	EXPORT_BTN_TITLE
static String	EXPORT_ENABLED
static String	ID
static String	URI
static String	VIEW_NAME

Fields inherited from class org.molgenis.framework.ui.MolgenisPluginController

PLUGIN_URI_PREFIX

Constructor Summary

Constructors

Constructor and Description
StudyManagerController(StudyManagerService studyDefinitionManagerService, CatalogManagerService catalogManagerService, MolgenisPermissionService molgenisPermissionService)

Method Summary

Methods

Modifier and Type	Method and Description
void	downloadStudyDefinition(String id, javax.servlet.http.HttpServletResponse response)
void	exportStudyDefinition(String id)
Map<String,Object>	getCatalogWithStudyDefinition(String id)
Map<String,Object>	getStudyDefinitionAsCatalog(String id)
String	getStudyDefinitions(org.springframework.ui.Model model) Show the available studydefinitions.
StudyManagerController.StudyDefinitionsMetaResponse	getStudyDefinitionsMeta(StudyDefinition.Status status, String search) Returns a list of meta data for each study definition
ErrorMessageResponse	handleException(Exception e)
ErrorMessageResponse	handleRuntimeException(RuntimeException e)
String	loadStudyDefinition(String id, org.springframework.ui.Model model) Loads a studydefinition by it's id.
void	updateStudyDefinition(String id, StudyManagerController.StudyDefinitionUpdateRequest updateRequest)

Methods inherited from class org.molgenis.framework.ui.MolgenisPluginController

getId, getUri

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

URI

public static final String URI

See Also:

Constant Field Values

VIEW_NAME

public static final String VIEW_NAME

See Also:

Constant Field Values

EXPORT_BTN_TITLE

public static final String EXPORT_BTN_TITLE

See Also:

Constant Field Values

EXPORT_ENABLED

public static final String EXPORT_ENABLED

See Also:

Constant Field Values

Constructor Detail

StudyManagerController

@Autowired
public StudyManagerController(StudyManagerService studyDefinitionManagerService,
                                CatalogManagerService catalogManagerService,
                                MolgenisPermissionService molgenisPermissionService)

Method Detail

getStudyDefinitions

@RequestMapping(method=GET)
public String getStudyDefinitions(org.springframework.ui.Model model)

Show the available studydefinitions. StudyDefinitions are exposed via a 'studyDefinitions' model attribute that contains a list of StudyDefinitionModel objects.

Parameters:

model -

Returns:

getStudyDefinitionsMeta

@RequestMapping(value="/list")
@ResponseBody
public StudyManagerController.StudyDefinitionsMetaResponse getStudyDefinitionsMeta(@RequestParam(value="state")
                                                                                                      StudyDefinition.Status status,
                                                                                                      @RequestParam(value="search",required=false)
                                                                                                      String search)

Returns a list of meta data for each study definition

Returns:

getStudyDefinitionAsCatalog

@RequestMapping(value="/view/{id}",
                method=GET)
@ResponseBody
public Map<String,Object> getStudyDefinitionAsCatalog(@PathVariable
                                                                         String id)
                                               throws UnknownCatalogException,
                                                      UnknownStudyDefinitionException

Throws:

UnknownCatalogException

UnknownStudyDefinitionException

getCatalogWithStudyDefinition

@RequestMapping(value="/edit/{id}",
                method=GET)
@ResponseBody
public Map<String,Object> getCatalogWithStudyDefinition(@PathVariable
                                                                           String id)
                                                 throws UnknownCatalogException,
                                                        UnknownStudyDefinitionException

Throws:

UnknownCatalogException

UnknownStudyDefinitionException

updateStudyDefinition

@RequestMapping(value="/update/{id}",
                method=POST)
@ResponseStatus(value=NO_CONTENT)
public void updateStudyDefinition(@PathVariable
                                                       String id,
                                                       @RequestBody
                                                       StudyManagerController.StudyDefinitionUpdateRequest updateRequest)
                           throws UnknownStudyDefinitionException,
                                  UnknownCatalogException

Throws:

UnknownStudyDefinitionException

UnknownCatalogException

exportStudyDefinition

@RequestMapping(value="/export/{id}",
                method=POST)
@ResponseStatus(value=NO_CONTENT)
public void exportStudyDefinition(@PathVariable
                                                       String id)
                           throws UnknownStudyDefinitionException,
                                  UnknownCatalogException

Throws:

UnknownStudyDefinitionException

UnknownCatalogException

loadStudyDefinition

@RequestMapping(value="/load",
                method=POST)
public String loadStudyDefinition(@RequestParam(value="id",required=false)
                                        String id,
                                        org.springframework.ui.Model model)

Loads a studydefinition by it's id. If an error occurred an 'errorMessage' model attribute is exposed. If the studydefinition was successfully loaded a 'successMessage' model attribute is exposed.

Parameters:

id -

model -

Returns:

downloadStudyDefinition

@RequestMapping(value="/download/{id}",
                method=GET)
public void downloadStudyDefinition(@PathVariable
                                          String id,
                                          javax.servlet.http.HttpServletResponse response)
                             throws UnknownStudyDefinitionException,
                                    IOException

Throws:

UnknownStudyDefinitionException

IOException

handleRuntimeException

@ExceptionHandler(value=java.lang.RuntimeException.class)
@ResponseStatus(value=INTERNAL_SERVER_ERROR)
@ResponseBody
public ErrorMessageResponse handleRuntimeException(RuntimeException e)

handleException

@ExceptionHandler(value=java.lang.Exception.class)
@ResponseBody
@ResponseStatus(value=BAD_REQUEST)
public ErrorMessageResponse handleException(Exception e)