StudyServiceHost

class StudyServiceHost(repository: StudyRepository, eventBus: ApplicationServiceEventBus<StudyService, StudyService.Event>) : StudyService
Content copied to clipboard

Implementation of StudyService which allows creating and managing studies.

Constructors

StudyServiceHost
Link copied to clipboard
fun StudyServiceHost(repository: StudyRepository, eventBus: ApplicationServiceEventBus<StudyService, StudyService.Event>)
Content copied to clipboard

Functions

createStudy
Link copied to clipboard
open suspend override fun createStudy(owner: StudyOwner, name: String, description: String?, invitation: StudyInvitation?): StudyStatus
Content copied to clipboard

Create a new study for the specified owner.

getStudiesOverview
Link copied to clipboard
open suspend override fun getStudiesOverview(owner: StudyOwner): List<StudyStatus>
Content copied to clipboard

Get status for all studies created by the specified owner.

getStudyDetails
Link copied to clipboard
open suspend override fun getStudyDetails(studyId: UUID): StudyDetails
Content copied to clipboard

Gets detailed information about the study with the specified studyId, including which study protocol is set.

getStudyStatus
Link copied to clipboard
open suspend override fun getStudyStatus(studyId: UUID): StudyStatus
Content copied to clipboard

Get the status for a study with the given studyId.

goLive
Link copied to clipboard
open suspend override fun goLive(studyId: UUID): StudyStatus
Content copied to clipboard

Lock in the current study protocol so that the study may be deployed to participants.

remove
Link copied to clipboard
open suspend override fun remove(studyId: UUID): Boolean
Content copied to clipboard

Remove the study with the specified studyId and all related data.

setInternalDescription
Link copied to clipboard
open suspend override fun setInternalDescription(studyId: UUID, name: String, description: String): StudyStatus
Content copied to clipboard

Set study details which are visible only to the StudyOwner.

setInvitation
Link copied to clipboard
open suspend override fun setInvitation(studyId: UUID, invitation: StudyInvitation): StudyStatus
Content copied to clipboard

Specify an invitation, shared with participants once they are invited to the study with the specified studyId.

setProtocol
Link copied to clipboard
open suspend override fun setProtocol(studyId: UUID, protocol: StudyProtocolSnapshot): StudyStatus
Content copied to clipboard

Specify the study protocol to use for the study with the specified studyId.