Study

class Study(owner: StudyOwner, name: String, description: String?, invitation: StudyInvitation, id: UUID) : AggregateRoot<Study, StudySnapshot, Study.Event>

Represents a study which can be pilot tested and eventually 'go live', for which a recruitment goal can be set, and participants can be recruited.

Constructors

Study

fun Study(owner: StudyOwner, name: String, description: String? = null, invitation: StudyInvitation = StudyInvitation( name ), id: UUID = UUID.randomUUID())

Types

Event

sealed class Event : DomainEvent

Factory

object Factory

Functions

consumeEvents

fun consumeEvents(): List<Study.Event>

getSnapshot

open override fun getSnapshot(): StudySnapshot

Get a serializable snapshot of the current state of this Study.

getStatus

fun getStatus(): StudyStatus

Get the status (serializable) of this Study.

getStudyDetails

fun getStudyDetails(): StudyDetails

Get StudyDetails for this Study.

goLive

fun goLive()

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

Properties

canDeployToParticipants

val canDeployToParticipants: Boolean

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

canSetInvitation

val canSetInvitation: Boolean

canSetStudyProtocol

val canSetStudyProtocol: Boolean

createdOn

var createdOn: Instant

description

var description: String?

A description for the study, assigned by, and only visible to, the StudyOwner.

id

val id: UUID

invitation

var invitation: StudyInvitation

A description of the study, shared with participants once they are invited to the study.

isLive

var isLive: Boolean = false

Determines whether a study protocol has been locked in and the study may be deployed to real participants.

name

var name: String

A descriptive name for the study, assigned by, and only visible to, the StudyOwner.

owner

val owner: StudyOwner

The person or group that created this Study.

protocolSnapshot

var protocolSnapshot: StudyProtocolSnapshot? = null

A snapshot of the protocol to use in this study, or null when not yet defined.