StudyStatus

Describes the status of a Study: the number of participants, progress towards study goal, etc.

Types

Configuring

data class Configuring(studyId: UUID, name: String, createdOn: Instant, canSetInvitation: Boolean, canSetStudyProtocol: Boolean, canDeployToParticipants: Boolean, canGoLive: Boolean) : StudyStatus

Study status for when a study is being configured.

Live

data class Live(studyId: UUID, name: String, createdOn: Instant, canSetInvitation: Boolean, canSetStudyProtocol: Boolean, canDeployToParticipants: Boolean) : StudyStatus

Study status for when a study is 'live'.

Properties

canDeployToParticipants

abstract val canDeployToParticipants: Boolean

Determines whether the study in its current state is ready to be deployed to participants.

canSetInvitation

abstract val canSetInvitation: Boolean

Determines whether the invitation which is shared with participants can be changed for the study.

canSetStudyProtocol

abstract val canSetStudyProtocol: Boolean

Determines whether a study protocol can be set/changed for the study.

createdOn

abstract val createdOn: Instant

The date when this study was created.

name

abstract val name: String

A descriptive name for the study, as assigned by the StudyOwner.

studyId

abstract val studyId: UUID

Inheritors

StudyStatus