StudyService

interface StudyService : ApplicationService<StudyService, StudyService.Event>

Application service which allows creating and managing studies.

Types

Event
Link copied to clipboard
sealed class Event : IntegrationEvent<StudyService>

Functions

createStudy
Link copied to clipboard
abstract suspend fun createStudy(owner: StudyOwner, name: String, description: String? = null, invitation: StudyInvitation? = null): StudyStatus

Create a new study for the specified owner.

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

Get status for all studies created by the specified owner.

getStudyDetails
Link copied to clipboard
abstract suspend fun getStudyDetails(studyId: UUID): StudyDetails

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

getStudyStatus
Link copied to clipboard
abstract suspend fun getStudyStatus(studyId: UUID): StudyStatus

Get the status for a study with the given studyId.

goLive
Link copied to clipboard
abstract suspend fun goLive(studyId: UUID): StudyStatus

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

remove
Link copied to clipboard
abstract suspend fun remove(studyId: UUID): Boolean

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

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

Set study details which are visible only to the StudyOwner.

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

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

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

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

Inheritors

StudyServiceHost
Link copied to clipboard