carp.studies.core/dk.cachet.carp.studies.domain/Study

Study

class Study(ownerId: UUID, name: String, description: String?, invitation: StudyInvitation, id: UUID, createdOn: Instant) : 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

fun Study(ownerId: UUID, name: String, description: String? = null, invitation: StudyInvitation = StudyInvitation( name ), id: UUID = UUID.randomUUID(), createdOn: Instant = Clock.System.now())

Types

sealed class Event : DomainEvent

object Factory

Functions

fun consumeEvents(): List<Study.Event>

fun getSnapshot(): StudySnapshot

fun getStatus(): StudyStatus

Get the status (serializable) of this Study.

getStudyDetails

fun getStudyDetails(): StudyDetails

Get StudyDetails for this Study.

fun goLive()

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

wasLoadedFromSnapshot

fun wasLoadedFromSnapshot(snapshot: StudySnapshot)

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

val createdOn: Instant

var description: String?

A description for the study, assigned by, and only visible to, the entity with ownerId.

fromSnapshotVersion

var fromSnapshotVersion: Int?

val id: UUID

var invitation: StudyInvitation

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

var isLive: Boolean = false

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

var name: String

A descriptive name for the study, assigned by, and only visible to, the entity with ownerId.

val ownerId: UUID

The ID of the entity (e.g., 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.