org.molgenis.studymanager

Interface StudyManagerService

All Known Implementing Classes:

OmxStudyManagerService

public interface StudyManagerService

Find, retrieve and persist study definitions

Author:

erwin

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLoadStudyData() Returns whether study data loading is enabled
StudyDefinition	createStudyDefinition(String username, String catalogId) Creates a new study definition for the given user based on a catalog
void	exportStudyDefinition(String id, String catalogId) Submit the draft study definition for the given catalog
List<StudyDefinition>	findStudyDefinitions(StudyDefinition.Status status, String search) Search study definitions
StudyDefinition	getStudyDefinition(String id) Find the study definition with the given id
List<StudyDefinition>	getStudyDefinitions() Find all study definitions
List<StudyDefinition>	getStudyDefinitions(String username) Find all studydefinitions of a user
List<StudyDefinition>	getStudyDefinitions(StudyDefinition.Status status) Find all study definition with the given status
boolean	isStudyDataActivated(String id) Returns whether study definition data is loaded
boolean	isStudyDataLoaded(String id) Returns whether study definition data is loaded
void	loadStudyData(String id) Retrieve a study definition and save it in the database
void	submitStudyDefinition(String id, String catalogId) Submit the draft study definition for the given catalog
void	updateStudyDefinition(StudyDefinition studyDefinition) Updates an existing study definition

Method Detail

getStudyDefinitions

List<StudyDefinition> getStudyDefinitions()

Find all study definitions

Returns:

getStudyDefinitions

List<StudyDefinition> getStudyDefinitions(StudyDefinition.Status status)

Find all study definition with the given status

Parameters:

status -

Returns:

findStudyDefinitions

List<StudyDefinition> findStudyDefinitions(StudyDefinition.Status status,
                                         String search)

Search study definitions

Parameters:

status -

search -

Returns:

getStudyDefinitions

List<StudyDefinition> getStudyDefinitions(String username)

Find all studydefinitions of a user

Parameters:

username -

Returns:

getStudyDefinition

StudyDefinition getStudyDefinition(String id)
                                   throws UnknownStudyDefinitionException

Find the study definition with the given id

Parameters:

id - study definition id

Returns:

Throws:

UnknownStudyDefinitionException

canLoadStudyData

boolean canLoadStudyData()

Returns whether study data loading is enabled

Returns:

loadStudyData

void loadStudyData(String id)
                   throws UnknownStudyDefinitionException

Retrieve a study definition and save it in the database

Parameters:

id - study definition id

Throws:

UnknownStudyDefinitionException

isStudyDataLoaded

boolean isStudyDataLoaded(String id)
                          throws UnknownStudyDefinitionException

Returns whether study definition data is loaded

Parameters:

id - study definition id

Returns:

Throws:

UnknownStudyDefinitionException

isStudyDataActivated

boolean isStudyDataActivated(String id)
                             throws UnknownStudyDefinitionException,
                                    UnknownCatalogException

Returns whether study definition data is loaded

Parameters:

id - study definition id

Returns:

Throws:

UnknownStudyDefinitionException

UnknownCatalogException

createStudyDefinition

StudyDefinition createStudyDefinition(String username,
                                    String catalogId)
                                      throws UnknownCatalogException

Creates a new study definition for the given user based on a catalog

Parameters:

username -

catalogId -

Returns:

study definition for the given user

Throws:

UnknownCatalogException

updateStudyDefinition

void updateStudyDefinition(StudyDefinition studyDefinition)
                           throws UnknownStudyDefinitionException

Updates an existing study definition

Parameters:

studyDefinition -

Throws:

UnknownStudyDefinitionException

submitStudyDefinition

void submitStudyDefinition(String id,
                         String catalogId)
                           throws UnknownStudyDefinitionException,
                                  UnknownCatalogException

Submit the draft study definition for the given catalog

Parameters:

id - study definition id

Throws:

UnknownStudyDefinitionException

UnknownCatalogException

exportStudyDefinition

void exportStudyDefinition(String id,
                         String catalogId)
                           throws UnknownStudyDefinitionException,
                                  UnknownCatalogException

Submit the draft study definition for the given catalog

Parameters:

id - study definition id

Throws:

UnknownStudyDefinitionException

UnknownCatalogException