org.molgenis.omx.protocolviewer

Interface ProtocolViewerService

All Known Implementing Classes:

ProtocolViewerServiceImpl

public interface ProtocolViewerService

Method Summary

Methods

Modifier and Type	Method and Description
void	addToStudyDefinitionDraftForCurrentUser(String resourceUri, String catalogId) Add a catalog item or catalog group (implies all items in a group) to the study definition draft
StudyDefinition	createStudyDefinitionDraftForCurrentUser(String catalogId) Creates a study definition draft for the current logged in user
void	createStudyDefinitionDraftXlsForCurrentUser(OutputStream outputStream, String catalogId) Write the study definition draft for the current user to the given stream
Iterable<CatalogMeta>	getCatalogs() Gets all active catalog meta data
StudyDefinition	getStudyDefinitionDraftForCurrentUser(String catalogId) Gets the current study definition draft for the current logged in user
StudyDefinition	getStudyDefinitionForCurrentUser(Integer id) Returns the given order for the current user
Iterable<StudyDefinition>	getStudyDefinitionsForCurrentUser() Returns order for the current user
void	removeFromStudyDefinitionDraftForCurrentUser(String resourceUri, String catalogId) Remove a catalog item or catalog group (implies all items in a group) from the study definition draft
void	submitStudyDefinitionDraftForCurrentUser(String studyName, javax.servlet.http.Part requestForm, String catalogId) Place an order for the current user

Method Detail

getCatalogs

Iterable<CatalogMeta> getCatalogs()

Gets all active catalog meta data

Returns:

meta data of active catalogs

getStudyDefinitionDraftForCurrentUser

StudyDefinition getStudyDefinitionDraftForCurrentUser(String catalogId)
                                                      throws UnknownCatalogException

Gets the current study definition draft for the current logged in user

Returns:

the current study definition draft or null if no study definition draft exists

Throws:

UnknownCatalogException

createStudyDefinitionDraftForCurrentUser

StudyDefinition createStudyDefinitionDraftForCurrentUser(String catalogId)
                                                         throws UnknownCatalogException

Creates a study definition draft for the current logged in user

Parameters:

catalogId - id of the catalog used for this study definition

Returns:

empty draft study definition

Throws:

UnknownCatalogException

getStudyDefinitionsForCurrentUser

Iterable<StudyDefinition> getStudyDefinitionsForCurrentUser()

Returns order for the current user

Returns:

getStudyDefinitionForCurrentUser

StudyDefinition getStudyDefinitionForCurrentUser(Integer id)
                                                 throws UnknownStudyDefinitionException

Returns the given order for the current user

Parameters:

id -

Returns:

Throws:

UnknownStudyDefinitionException

submitStudyDefinitionDraftForCurrentUser

void submitStudyDefinitionDraftForCurrentUser(String studyName,
                                            javax.servlet.http.Part requestForm,
                                            String catalogId)
                                              throws javax.mail.MessagingException,
                                                     IOException,
                                                     UnknownCatalogException,
                                                     UnknownStudyDefinitionException

Place an order for the current user

Parameters:

studyName -

requestForm -

Throws:

javax.mail.MessagingException

IOException

UnknownCatalogException

UnknownStudyDefinitionException

addToStudyDefinitionDraftForCurrentUser

void addToStudyDefinitionDraftForCurrentUser(String resourceUri,
                                           String catalogId)
                                             throws UnknownCatalogException

Add a catalog item or catalog group (implies all items in a group) to the study definition draft

Parameters:

resourceUri -

catalogId -

Throws:

UnknownCatalogException

removeFromStudyDefinitionDraftForCurrentUser

void removeFromStudyDefinitionDraftForCurrentUser(String resourceUri,
                                                String catalogId)
                                                  throws UnknownCatalogException

Remove a catalog item or catalog group (implies all items in a group) from the study definition draft

Parameters:

resourceUri -

catalogId -

Throws:

UnknownCatalogException

createStudyDefinitionDraftXlsForCurrentUser

void createStudyDefinitionDraftXlsForCurrentUser(OutputStream outputStream,
                                               String catalogId)
                                                 throws IOException,
                                                        UnknownCatalogException

Write the study definition draft for the current user to the given stream

Parameters:

outputStream -

Throws:

IOException

UnknownCatalogException