Study Service
interface StudyService : ApplicationService<StudyService, StudyService.Event>
Content copied to clipboard
Application service which allows creating and managing studies.
Types
Event
Link copied to clipboard
Functions
create Study
Link copied to clipboard
abstract suspend fun createStudy(owner: StudyOwner, name: String, description: String? = null, invitation: StudyInvitation? = null): StudyStatus
Content copied to clipboard
Create a new study for the specified owner.
get Studies Overview
Link copied to clipboard
abstract suspend fun getStudiesOverview(owner: StudyOwner): List<StudyStatus>
Content copied to clipboard
Get status for all studies created by the specified owner.
get Study Details
Link copied to clipboard
Gets detailed information about the study with the specified studyId, including which study protocol is set.
get Study Status
Link copied to clipboard
Get the status for a study with the given studyId.
go Live
Link copied to clipboard
Lock in the current study protocol so that the study may be deployed to participants.
set Internal Description
Link copied to clipboard
abstract suspend fun setInternalDescription(studyId: UUID, name: String, description: String): StudyStatus
Content copied to clipboard
Set study details which are visible only to the StudyOwner.
set Invitation
Link copied to clipboard
abstract suspend 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.
set Protocol
Link copied to clipboard
abstract suspend fun setProtocol(studyId: UUID, protocol: StudyProtocolSnapshot): StudyStatus
Content copied to clipboard
Inheritors
StudyServiceHost
Link copied to clipboard