carp.studies.core/dk.cachet.carp.studies.application/StudyStatus

StudyStatus

@Serializable
sealed class StudyStatus

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

Types

Link copied to clipboard
@Serializable
data class Configuring(val studyId: UUID, val name: String, val createdOn: Instant, val studyProtocolId: UUID?, val canSetInvitation: Boolean, val canSetStudyProtocol: Boolean, val canDeployToParticipants: Boolean, val canGoLive: Boolean) : StudyStatus

Study status for when a study is being configured.

Link copied to clipboard
@Serializable
data class Live(val studyId: UUID, val name: String, val createdOn: Instant, val studyProtocolId: UUID?, val canSetInvitation: Boolean, val canSetStudyProtocol: Boolean, val canDeployToParticipants: Boolean) : StudyStatus

Study status for when a study is 'live'.

Properties

Link copied to clipboard
abstract val canDeployToParticipants: Boolean

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

Link copied to clipboard
abstract val canSetInvitation: Boolean

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

Link copied to clipboard
abstract val canSetStudyProtocol: Boolean

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

Link copied to clipboard
abstract val createdOn: Instant

The date when this study was created.

Link copied to clipboard
abstract val name: String

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

Link copied to clipboard
abstract val studyId: UUID
Link copied to clipboard
abstract val studyProtocolId: UUID?

In case a study protocol for this study is set, its id; null otherwise.

Inheritors

Link copied to clipboard
Link copied to clipboard