carp.studies.core/dk.cachet.carp.studies.domain.users/Recruitment

Recruitment

class Recruitment(val studyId: UUID, id: UUID = UUID.randomUUID(), createdOn: Instant = Clock.System.now()) : AggregateRoot<Recruitment, RecruitmentSnapshot, Recruitment.Event>

Represents a set of participants recruited for a study identified by studyId.

Constructors

Recruitment

fun Recruitment(studyId: UUID, id: UUID = UUID.randomUUID(), createdOn: Instant = Clock.System.now())

Types

Companion

object Companion

Event

sealed class Event : DomainEvent

Functions

addParticipant

fun addParticipant(email: EmailAddress, id: UUID = UUID.randomUUID()): Participant

Add a Participant identified by the specified email address. In case the email was already added before, the same Participant is returned.

addParticipantGroup

fun addParticipantGroup(participantIds: Set<UUID>, id: UUID = UUID.randomUUID()): StagedParticipantGroup

Create and add the participants identified by participantIds as a participant group.

consumeEvents

fun consumeEvents(): List<Recruitment.Event>

createInvitations

fun createInvitations(group: Set<AssignedParticipantRoles>): Pair<StudyProtocolSnapshot, List<ParticipantInvitation>>

Attempt creating ParticipantInvitations for the specified participant group, or throw exception in case preconditions are violated.

getParticipantGroupStatus

fun getParticipantGroupStatus(studyDeploymentStatus: StudyDeploymentStatus): ParticipantGroupStatus

Get the ParticipantGroupStatus of the study deployment identified by studyDeploymentStatus.

getSnapshot

fun getSnapshot(): RecruitmentSnapshot

getStatus

fun getStatus(): RecruitmentStatus

Get the status (serializable) of this Recruitment.

lockInStudy

fun lockInStudy(protocol: StudyProtocolSnapshot, invitation: StudyInvitation)

Lock in the protocol which participants in this recruitment can participate in, and the invitation which is sent to them once they are deployed.

wasLoadedFromSnapshot

fun wasLoadedFromSnapshot(snapshot: RecruitmentSnapshot)

Properties

createdOn

val createdOn: Instant

fromSnapshotVersion

var fromSnapshotVersion: Int?

val id: UUID

participantGroups

val participantGroups: Map<UUID, StagedParticipantGroup>

Per study deployment ID, the group of participants that participates in it.

participants

val participants: Set<Participant>

The participants which are part of this Recruitment.

studyId

val studyId: UUID