org.molgenis.omx.studymanager

Class OmxStudyManagerService

java.lang.Object

org.molgenis.omx.studymanager.OmxStudyManagerService

All Implemented Interfaces:

StudyManagerService

public class OmxStudyManagerService
extends Object
implements StudyManagerService

Constructor Summary

Constructors

Constructor and Description
OmxStudyManagerService(DataService dataService, MolgenisUserService molgenisUserService)

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
StudyDefinition	createStudyDefinition(String username, String catalogId, String omxIdentifier)
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

Methods inherited from class java.lang.Object

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

Constructor Detail

OmxStudyManagerService

public OmxStudyManagerService(DataService dataService,
                      MolgenisUserService molgenisUserService)

Method Detail

getStudyDefinitions

public List<StudyDefinition> getStudyDefinitions()

Description copied from interface: StudyManagerService

Find all study definitions

Specified by:

getStudyDefinitions in interface StudyManagerService

Returns:

getStudyDefinitions

public List<StudyDefinition> getStudyDefinitions(StudyDefinition.Status status)

Description copied from interface: StudyManagerService

Find all study definition with the given status

Specified by:

getStudyDefinitions in interface StudyManagerService

Returns:

getStudyDefinitions

public List<StudyDefinition> getStudyDefinitions(String username)

Description copied from interface: StudyManagerService

Find all studydefinitions of a user

Specified by:

getStudyDefinitions in interface StudyManagerService

Returns:

getStudyDefinition

public StudyDefinition getStudyDefinition(String id)
                                   throws UnknownStudyDefinitionException

Description copied from interface: StudyManagerService

Find the study definition with the given id

Specified by:

getStudyDefinition in interface StudyManagerService

Parameters:

id - study definition id

Returns:

Throws:

UnknownStudyDefinitionException

canLoadStudyData

public boolean canLoadStudyData()

Description copied from interface: StudyManagerService

Returns whether study data loading is enabled

Specified by:

canLoadStudyData in interface StudyManagerService

Returns:

loadStudyData

public void loadStudyData(String id)
                   throws UnknownStudyDefinitionException

Description copied from interface: StudyManagerService

Retrieve a study definition and save it in the database

Specified by:

loadStudyData in interface StudyManagerService

Parameters:

id - study definition id

Throws:

UnknownStudyDefinitionException

isStudyDataLoaded

public boolean isStudyDataLoaded(String id)
                          throws UnknownStudyDefinitionException

Description copied from interface: StudyManagerService

Returns whether study definition data is loaded

Specified by:

isStudyDataLoaded in interface StudyManagerService

Parameters:

id - study definition id

Returns:

Throws:

UnknownStudyDefinitionException

isStudyDataActivated

public boolean isStudyDataActivated(String id)
                             throws UnknownStudyDefinitionException

Description copied from interface: StudyManagerService

Returns whether study definition data is loaded

Specified by:

isStudyDataActivated in interface StudyManagerService

Parameters:

id - study definition id

Returns:

Throws:

UnknownStudyDefinitionException

createStudyDefinition

public StudyDefinition createStudyDefinition(String username,
                                    String catalogId)

Description copied from interface: StudyManagerService

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

Specified by:

createStudyDefinition in interface StudyManagerService

Returns:

study definition for the given user

createStudyDefinition

public StudyDefinition createStudyDefinition(String username,
                                    String catalogId,
                                    String omxIdentifier)

updateStudyDefinition

public void updateStudyDefinition(StudyDefinition studyDefinition)
                           throws UnknownStudyDefinitionException

Description copied from interface: StudyManagerService

Updates an existing study definition

Specified by:

updateStudyDefinition in interface StudyManagerService

Throws:

UnknownStudyDefinitionException

submitStudyDefinition

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

Description copied from interface: StudyManagerService

Submit the draft study definition for the given catalog

Specified by:

submitStudyDefinition in interface StudyManagerService

Parameters:

id - study definition id

Throws:

UnknownStudyDefinitionException

UnknownCatalogException

exportStudyDefinition

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

Description copied from interface: StudyManagerService

Submit the draft study definition for the given catalog

Specified by:

exportStudyDefinition in interface StudyManagerService

Parameters:

id - study definition id

Throws:

UnknownStudyDefinitionException

UnknownCatalogException

findStudyDefinitions

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

Description copied from interface: StudyManagerService

Search study definitions

Specified by:

findStudyDefinitions in interface StudyManagerService

Returns: