deployment/carp_core_deployment library
Maps the information specified in a study protocol to runtime configurations used by the 'clients' subsystem to run the protocol on concrete devices (e.g., a smartphone) and allow researchers to monitor their state. To start collecting data, participants need to be invited, devices need to be registered, and consent needs to be given to collect the requested data.
Contains the core deployment classes like PrimaryDeviceDeployment, StudyDeployment, ParticipantData, and DeploymentService.
See the carp.deployments
definition in Kotlin.
Classes
- ActiveParticipationInvitation
- An invitation to participate in an active study deployment using the assignedDevices. Some of the devices which the participant is invited to might already be registered. If the participant wants to use a different device, they will need to unregister the existing device first.
- AssignedPrimaryDevice
- Primary device and its current registration assigned to participants as part of a participant group.
- CreateStudyDeployment
- A request for creating a deployment based on the protocol.
- DeploymentService
- Application service which allows deploying study protocols to participants and retrieving PrimaryDeviceDeployment's for participating primary devices as defined in the protocol.
- DeploymentServiceRequest
- A DeploymentServiceRequest and all its sub-classes contain the data for sending a RPC request to the CARP web service.
- DeviceDeployed
- A request for reporting this deployment as successful.
- DeviceDeploymentStatus
- A DeviceDeploymentStatus represents the status of a device in a deployment.
- GetActiveParticipationInvitations
- A request for getting the deployment invitations for an account id.
- GetDeviceDeploymentFor
- A request for getting the deployment for this primary device.
- GetParticipantData
- A request for getting the status of a study deployment.
- GetParticipantDataList
- A request for getting the list of participant data for this a list of studyDeploymentIds.
- GetStudyDeploymentStatus
- A request for getting the status of a study deployment.
- GetStudyDeploymentStatusList
- A request for getting the status of a list of study deployment.
- ParticipantData
-
Expected participant
datafor all participants in a study deployment with studyDeploymentId. - ParticipantInvitation
- The information which needs to be provided when inviting a participant to a deployment.
- ParticipantStatus
- Provides information on the status of a participant in a study deployment.
- Participation
- Uniquely identifies the participation of an account in a study deployment.
- ParticipationService
- Application service which allows inviting participants, retrieving participations for study deployments, and managing data related to participants which is input by users.
- ParticipationServiceRequest
- A ParticipationServiceRequest and its sub-classes contain the data for sending a participant request to the CARP web service.
- PrimaryDeviceDeployment
- Contains the entire description and configuration for how a single primary device participates in running a study.
- RegisterDevice
- A request for registering this device.
- RoleData
- Expected participant data for all participants with a specific roleName.
- SetParticipantData
- A request for adding data for a participant.
- Stop
- A request for permanently stopping a study deployment.
- StudyDeployment
- A single instantiation of a StudyProtocol, taking care of common concerns related to devices when 'running' a study.
- StudyDeploymentStatus
- A StudyDeploymentStatus represents the status of a deployment as returned from the CARP web service.
- StudyInvitation
- A description of a study, shared with participants once they are invited to a study.
- UnregisterDevice
- A request for unregistering this device.
Enums
- DeviceDeploymentStatusTypes
- The types of device deployment status.
- StudyDeploymentStatusTypes
- The types of study deployment status.