org.sagebionetworks.bridge.rest.model

Class ParticipantVersion

java.lang.Object

org.sagebionetworks.bridge.rest.model.ParticipantVersion

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2023-07-13T01:30:51.265Z")
public class ParticipantVersion
extends Object

Represents a de-identified snapshot of a study participant at a moment in time. This is used by Exporter 3.0 to generate the de-identified participant roster.

Constructor Summary

Constructors

Constructor and Description
ParticipantVersion()

Method Summary

Modifier and Type	Method and Description
ParticipantVersion	addDataGroupsItem(String dataGroupsItem)
ParticipantVersion	addLanguagesItem(String languagesItem)
ParticipantVersion	appDemographics(Map<String,DemographicResponse> appDemographics)
ParticipantVersion	appId(String appId)
ParticipantVersion	createdOn(DateTime createdOn)
ParticipantVersion	dataGroups(List<String> dataGroups)
boolean	equals(Object o)
Map<String,DemographicResponse>	getAppDemographics() Maps demographic category name to demographic information for a specific category of app demographics.
String	getAppId() App that the participant lives in.
DateTime	getCreatedOn() ISO timestamp of when any version of this participant was first created.
List<String>	getDataGroups() Data groups assigned to this participant.
String	getHealthCode() Participant's health code.
List<String>	getLanguages() Languages captured from a request by this user's Accept-Language header.
DateTime	getModifiedOn() ISO timestamp of when this participant was last updated (ie, when this participant version was created).
Integer	getParticipantVersion() Participant version.
SharingScope	getSharingScope() Get sharingScope
Map<String,Map<String,DemographicResponse>>	getStudyDemographics() Maps studyId to the user's demographic information for a particular study.
Map<String,String>	getStudyMemberships() The studies assigned to the user, and the optional external ID being used for each assignment, if any.
String	getTimeZone() Participant's time zone, as an IANA time zone name (eg \"America/Los_Angeles\").
String	getType() ParticipantVersion
int	hashCode()
ParticipantVersion	healthCode(String healthCode)
ParticipantVersion	languages(List<String> languages)
ParticipantVersion	modifiedOn(DateTime modifiedOn)
ParticipantVersion	participantVersion(Integer participantVersion)
ParticipantVersion	putAppDemographicsItem(String key, DemographicResponse appDemographicsItem)
ParticipantVersion	putStudyDemographicsItem(String key, Map<String,DemographicResponse> studyDemographicsItem)
ParticipantVersion	putStudyMembershipsItem(String key, String studyMembershipsItem)
void	setAppDemographics(Map<String,DemographicResponse> appDemographics)
void	setAppId(String appId)
void	setCreatedOn(DateTime createdOn)
void	setDataGroups(List<String> dataGroups)
void	setHealthCode(String healthCode)
void	setLanguages(List<String> languages)
void	setModifiedOn(DateTime modifiedOn)
void	setParticipantVersion(Integer participantVersion)
void	setSharingScope(SharingScope sharingScope)
void	setStudyDemographics(Map<String,Map<String,DemographicResponse>> studyDemographics)
void	setStudyMemberships(Map<String,String> studyMemberships)
void	setTimeZone(String timeZone)
ParticipantVersion	sharingScope(SharingScope sharingScope)
ParticipantVersion	studyDemographics(Map<String,Map<String,DemographicResponse>> studyDemographics)
ParticipantVersion	studyMemberships(Map<String,String> studyMemberships)
ParticipantVersion	timeZone(String timeZone)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ParticipantVersion

public ParticipantVersion()

Method Detail

appId

public ParticipantVersion appId(String appId)

getAppId

public String getAppId()

App that the participant lives in.

Returns:

appId

setAppId

public void setAppId(String appId)

healthCode

public ParticipantVersion healthCode(String healthCode)

getHealthCode

public String getHealthCode()

Participant's health code.

Returns:

healthCode

setHealthCode

public void setHealthCode(String healthCode)

participantVersion

public ParticipantVersion participantVersion(Integer participantVersion)

getParticipantVersion

public Integer getParticipantVersion()

Participant version. This is incremented every time the participant is updated and we create a new row.

Returns:

participantVersion

setParticipantVersion

public void setParticipantVersion(Integer participantVersion)

createdOn

public ParticipantVersion createdOn(DateTime createdOn)

getCreatedOn

public DateTime getCreatedOn()

ISO timestamp of when any version of this participant was first created.

Returns:

createdOn

setCreatedOn

public void setCreatedOn(DateTime createdOn)

modifiedOn

public ParticipantVersion modifiedOn(DateTime modifiedOn)

getModifiedOn

public DateTime getModifiedOn()

ISO timestamp of when this participant was last updated (ie, when this participant version was created).

Returns:

modifiedOn

setModifiedOn

public void setModifiedOn(DateTime modifiedOn)

dataGroups

public ParticipantVersion dataGroups(List<String> dataGroups)

addDataGroupsItem

public ParticipantVersion addDataGroupsItem(String dataGroupsItem)

getDataGroups

public List<String> getDataGroups()

Data groups assigned to this participant.

Returns:

dataGroups

setDataGroups

public void setDataGroups(List<String> dataGroups)

languages

public ParticipantVersion languages(List<String> languages)

addLanguagesItem

public ParticipantVersion addLanguagesItem(String languagesItem)

getLanguages

public List<String> getLanguages()

Languages captured from a request by this user's Accept-Language header. This should be an ordered list of unique ISO 639-1 language codes.

Returns:

languages

setLanguages

public void setLanguages(List<String> languages)

sharingScope

public ParticipantVersion sharingScope(SharingScope sharingScope)

getSharingScope

public SharingScope getSharingScope()

Get sharingScope

Returns:

sharingScope

setSharingScope

public void setSharingScope(SharingScope sharingScope)

studyMemberships

public ParticipantVersion studyMemberships(Map<String,String> studyMemberships)

putStudyMembershipsItem

public ParticipantVersion putStudyMembershipsItem(String key,
                                                  String studyMembershipsItem)

getStudyMemberships

public Map<String,String> getStudyMemberships()

The studies assigned to the user, and the optional external ID being used for each assignment, if any. The keys of this map are study IDs, and the values are either the associated external ID, or null if there is no associated external ID. When exporting to Synapse, if the project is study specific, the Exporter will only export that specific study's external ID.

Returns:

studyMemberships

setStudyMemberships

public void setStudyMemberships(Map<String,String> studyMemberships)

timeZone

public ParticipantVersion timeZone(String timeZone)

getTimeZone

public String getTimeZone()

Participant's time zone, as an IANA time zone name (eg \"America/Los_Angeles\").

Returns:

timeZone

setTimeZone

public void setTimeZone(String timeZone)

appDemographics

public ParticipantVersion appDemographics(Map<String,DemographicResponse> appDemographics)

putAppDemographicsItem

public ParticipantVersion putAppDemographicsItem(String key,
                                                 DemographicResponse appDemographicsItem)

getAppDemographics

public Map<String,DemographicResponse> getAppDemographics()

Maps demographic category name to demographic information for a specific category of app demographics.

Returns:

appDemographics

setAppDemographics

public void setAppDemographics(Map<String,DemographicResponse> appDemographics)

studyDemographics

public ParticipantVersion studyDemographics(Map<String,Map<String,DemographicResponse>> studyDemographics)

putStudyDemographicsItem

public ParticipantVersion putStudyDemographicsItem(String key,
                                                   Map<String,DemographicResponse> studyDemographicsItem)

getStudyDemographics

public Map<String,Map<String,DemographicResponse>> getStudyDemographics()

Maps studyId to the user's demographic information for a particular study.

Returns:

studyDemographics

setStudyDemographics

public void setStudyDemographics(Map<String,Map<String,DemographicResponse>> studyDemographics)

getType

public String getType()

ParticipantVersion

Returns:

type

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object