StudyParticipant (REST Client 0.25.15 API)

java.lang.Object
- org.sagebionetworks.bridge.rest.model.StudyParticipant

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class StudyParticipant
extends Object

StudyParticipant

Constructor Summary

Constructors
Constructor and Description

StudyParticipant()

Constructors
Constructor and Description
`StudyParticipant()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StudyParticipant`	`addDataGroupsItem(String dataGroupsItem)`
`StudyParticipant`	`addLanguagesItem(String languagesItem)`
`StudyParticipant`	`addRolesItem(Role rolesItem)`
`StudyParticipant`	`attributes(Map<String,String> attributes)`
`StudyParticipant`	`clientData(Object clientData)`
`StudyParticipant`	`clientTimeZone(String clientTimeZone)`
`StudyParticipant`	`consented(Boolean consented)`
`StudyParticipant`	`dataGroups(List<String> dataGroups)`
`StudyParticipant`	`email(String email)`
`StudyParticipant`	`emailVerified(Boolean emailVerified)`
`boolean`	`equals(Object o)`
`StudyParticipant`	`externalIds(Map<String,String> externalIds)`
`StudyParticipant`	`firstName(String firstName)`
`Map<String,String>`	`getAttributes()` A map of user profile attributes that have been set for this user (the attributes themselves must be specified in the app's configuration, and the values are stored encrypted in case they capture personally-identifying information).
`Object`	`getClientData()` Client data for a user should be in a syntactically valid JSON format.
`String`	`getClientTimeZone()` Participant's time zone.
`Map<String,List<UserConsentHistory>>`	`getConsentHistories()` A complete historical record of all the user's consents and withdrawals of consent for all studies in the app.
`DateTime`	`getCreatedOn()` The date and time the account was created.
`List<String>`	`getDataGroups()` The data groups set for this user.
`String`	`getEmail()` The user's email.
`Map<String,EnrollmentInfo>`	`getEnrollments()` Records of every enrollment (whether withdrawn or not) in every study for this participant.
`Map<String,String>`	`getExternalIds()` The exernal IDs this participant is associated to, mapped to the study that issued the external ID.
`String`	`getFirstName()` First name (given name) of the user.
`String`	`getHealthCode()` Only included in studies that have been configured to return the health code, and only to researchers through the researcher APIs.
`String`	`getId()` An ID assigned to this account by Bridge system.
`List<String>`	`getLanguages()` Two letter language codes to assign to this user (these are initially retrieved from the user's `Accept-Language` header and then persisted as part of account configuration).
`String`	`getLastName()` Last name (family name) of the user.
`String`	`getNote()` Optional note related to user account.
`String`	`getOrgMembership()` The identifier of the organization this account is a member of (this will be an administrative account and not a study participant).
`Phone`	`getPhone()` Get phone
`List<Role>`	`getRoles()` Get roles
`SharingScope`	`getSharingScope()` Get sharingScope
`AccountStatus`	`getStatus()` Get status
`List<String>`	`getStudyIds()` The studies this participant is associated to.
`String`	`getSynapseUserId()` The numerical identifier for a Synapse account.
`String`	`getTimeZone()` User's original time zone, as measured by the timezone used to request activities, as a string offset in ISO8601 format.
`String`	`getType()` StudyParticipant
`int`	`hashCode()`
`Boolean`	`isConsented()` True if the user has consented to all required consents, based on the user's most recent request info (client info, languages, data groups).
`Boolean`	`isEmailVerified()` Has the user verified that they have control of this email address?
`Boolean`	`isNotifyByEmail()` True if the user has consented to be contacted via email outside the application, false otherwise.
`Boolean`	`isPhoneVerified()` Has the user verified that they have control of this phone number?
`StudyParticipant`	`languages(List<String> languages)`
`StudyParticipant`	`lastName(String lastName)`
`StudyParticipant`	`note(String note)`
`StudyParticipant`	`notifyByEmail(Boolean notifyByEmail)`
`StudyParticipant`	`orgMembership(String orgMembership)`
`StudyParticipant`	`phone(Phone phone)`
`StudyParticipant`	`phoneVerified(Boolean phoneVerified)`
`StudyParticipant`	`putAttributesItem(String key, String attributesItem)`
`StudyParticipant`	`putExternalIdsItem(String key, String externalIdsItem)`
`StudyParticipant`	`roles(List<Role> roles)`
`void`	`setAttributes(Map<String,String> attributes)`
`void`	`setClientData(Object clientData)`
`void`	`setClientTimeZone(String clientTimeZone)`
`void`	`setConsented(Boolean consented)`
`void`	`setDataGroups(List<String> dataGroups)`
`void`	`setEmail(String email)`
`void`	`setEmailVerified(Boolean emailVerified)`
`void`	`setExternalIds(Map<String,String> externalIds)`
`void`	`setFirstName(String firstName)`
`void`	`setLanguages(List<String> languages)`
`void`	`setLastName(String lastName)`
`void`	`setNote(String note)`
`void`	`setNotifyByEmail(Boolean notifyByEmail)`
`void`	`setOrgMembership(String orgMembership)`
`void`	`setPhone(Phone phone)`
`void`	`setPhoneVerified(Boolean phoneVerified)`
`void`	`setRoles(List<Role> roles)`
`void`	`setSharingScope(SharingScope sharingScope)`
`void`	`setStatus(AccountStatus status)`
`void`	`setSynapseUserId(String synapseUserId)`
`void`	`setTimeZone(String timeZone)`
`StudyParticipant`	`sharingScope(SharingScope sharingScope)`
`StudyParticipant`	`status(AccountStatus status)`
`StudyParticipant`	`synapseUserId(String synapseUserId)`
`StudyParticipant`	`timeZone(String timeZone)`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StudyParticipant
```
public StudyParticipant()
```
- Method Detail
  - firstName
```
public StudyParticipant firstName(String firstName)
```
  - getFirstName
```
public String getFirstName()
```
    First name (given name) of the user.
    
    Returns:
    
    firstName
  - setFirstName
```
public void setFirstName(String firstName)
```
  - lastName
```
public StudyParticipant lastName(String lastName)
```
  - getLastName
```
public String getLastName()
```
    Last name (family name) of the user.
    
    Returns:
    
    lastName
  - setLastName
```
public void setLastName(String lastName)
```
  - synapseUserId
```
public StudyParticipant synapseUserId(String synapseUserId)
```
  - getSynapseUserId
```
public String getSynapseUserId()
```
    The numerical identifier for a Synapse account. For administrative accounts, this will allow the user to sign in using Synapse accounts, no further credentials are needed to access the system. This value can only be set when creating an account; otherwise the identifiers update API must be used to add the ID to an existing account.
    
    Returns:
    
    synapseUserId
  - setSynapseUserId
```
public void setSynapseUserId(String synapseUserId)
```
  - getId
```
public String getId()
```
    An ID assigned to this account by Bridge system. This ID is exposed in the API and is different from the health code assigned to the user's anonymized data. Bridge never exports this ID along with the health code from Bridge.
    
    Returns:
    
    id
  - notifyByEmail
```
public StudyParticipant notifyByEmail(Boolean notifyByEmail)
```
  - isNotifyByEmail
```
public Boolean isNotifyByEmail()
```
    True if the user has consented to be contacted via email outside the application, false otherwise.
    
    Returns:
    
    notifyByEmail
  - setNotifyByEmail
```
public void setNotifyByEmail(Boolean notifyByEmail)
```
  - attributes
```
public StudyParticipant attributes(Map<String,String> attributes)
```
  - putAttributesItem
```
public StudyParticipant putAttributesItem(String key,
                                          String attributesItem)
```
  - getAttributes
```
public Map<String,String> getAttributes()
```
    A map of user profile attributes that have been set for this user (the attributes themselves must be specified in the app's configuration, and the values are stored encrypted in case they capture personally-identifying information).
    
    Returns:
    
    attributes
  - setAttributes
```
public void setAttributes(Map<String,String> attributes)
```
  - sharingScope
```
public StudyParticipant sharingScope(SharingScope sharingScope)
```
  - getSharingScope
```
public SharingScope getSharingScope()
```
    Get sharingScope
    
    Returns:
    
    sharingScope
  - setSharingScope
```
public void setSharingScope(SharingScope sharingScope)
```
  - getCreatedOn
```
public DateTime getCreatedOn()
```
    The date and time the account was created.
    
    Returns:
    
    createdOn
  - emailVerified
```
public StudyParticipant emailVerified(Boolean emailVerified)
```
  - isEmailVerified
```
public Boolean isEmailVerified()
```
    Has the user verified that they have control of this email address?
    
    Returns:
    
    emailVerified
  - setEmailVerified
```
public void setEmailVerified(Boolean emailVerified)
```
  - phoneVerified
```
public StudyParticipant phoneVerified(Boolean phoneVerified)
```
  - isPhoneVerified
```
public Boolean isPhoneVerified()
```
    Has the user verified that they have control of this phone number?
    
    Returns:
    
    phoneVerified
  - setPhoneVerified
```
public void setPhoneVerified(Boolean phoneVerified)
```
  - status
```
public StudyParticipant status(AccountStatus status)
```
  - getStatus
```
public AccountStatus getStatus()
```
    Get status
    
    Returns:
    
    status
  - setStatus
```
public void setStatus(AccountStatus status)
```
  - roles
```
public StudyParticipant roles(List<Role> roles)
```
  - addRolesItem
```
public StudyParticipant addRolesItem(Role rolesItem)
```
  - getRoles
```
public List<Role> getRoles()
```
    Get roles
    
    Returns:
    
    roles
  - setRoles
```
public void setRoles(List<Role> roles)
```
  - dataGroups
```
public StudyParticipant dataGroups(List<String> dataGroups)
```
  - addDataGroupsItem
```
public StudyParticipant addDataGroupsItem(String dataGroupsItem)
```
  - getDataGroups
```
public List<String> getDataGroups()
```
    The data groups set for this user. Data groups must be strings that are defined in the list of all valid data groups for the app, as part of the app object.
    
    Returns:
    
    dataGroups
  - setDataGroups
```
public void setDataGroups(List<String> dataGroups)
```
  - clientData
```
public StudyParticipant clientData(Object clientData)
```
  - getClientData
```
public Object getClientData()
```
    Client data for a user should be in a syntactically valid JSON format. It will be returned as is to the client (as JSON).
    
    Returns:
    
    clientData
  - setClientData
```
public void setClientData(Object clientData)
```
  - languages
```
public StudyParticipant languages(List<String> languages)
```
  - addLanguagesItem
```
public StudyParticipant addLanguagesItem(String languagesItem)
```
  - getLanguages
```
public List<String> getLanguages()
```
    Two letter language codes to assign to this user (these are initially retrieved from the user's `Accept-Language` header and then persisted as part of account configuration).
    
    Returns:
    
    languages
  - setLanguages
```
public void setLanguages(List<String> languages)
```
  - getStudyIds
```
public List<String> getStudyIds()
```
    The studies this participant is associated to. For administrative accounts, these are the studies associated to the account's organization. For study participants, these will be the studies that the person is enrolled in.
    
    Returns:
    
    studyIds
  - externalIds
```
public StudyParticipant externalIds(Map<String,String> externalIds)
```
  - putExternalIdsItem
```
public StudyParticipant putExternalIdsItem(String key,
                                           String externalIdsItem)
```
  - getExternalIds
```
public Map<String,String> getExternalIds()
```
    The exernal IDs this participant is associated to, mapped to the study that issued the external ID. Typically a user signs up with the external ID, and is assigned to that study as a result.
    
    Returns:
    
    externalIds
  - setExternalIds
```
public void setExternalIds(Map<String,String> externalIds)
```
  - orgMembership
```
public StudyParticipant orgMembership(String orgMembership)
```
  - getOrgMembership
```
public String getOrgMembership()
```
    The identifier of the organization this account is a member of (this will be an administrative account and not a study participant). Once set, it cannot be changed on an update (there are separate organization membership APIs to change organizational membership).
    
    Returns:
    
    orgMembership
  - setOrgMembership
```
public void setOrgMembership(String orgMembership)
```
  - note
```
public StudyParticipant note(String note)
```
  - getNote
```
public String getNote()
```
    Optional note related to user account. Can only be edited and viewed by an administrative account.
    
    Returns:
    
    note
  - setNote
```
public void setNote(String note)
```
  - clientTimeZone
```
public StudyParticipant clientTimeZone(String clientTimeZone)
```
  - getClientTimeZone
```
public String getClientTimeZone()
```
    Participant's time zone. Can be updated or deleted. Must be an IANA time zone name.
    
    Returns:
    
    clientTimeZone
  - setClientTimeZone
```
public void setClientTimeZone(String clientTimeZone)
```
  - getHealthCode
```
public String getHealthCode()
```
    Only included in studies that have been configured to return the health code, and only to researchers through the researcher APIs.
    
    Returns:
    
    healthCode
  - email
```
public StudyParticipant email(String email)
```
  - getEmail
```
public String getEmail()
```
    The user's email.
    
    Returns:
    
    email
  - setEmail
```
public void setEmail(String email)
```
  - phone
```
public StudyParticipant phone(Phone phone)
```
  - getPhone
```
public Phone getPhone()
```
    Get phone
    
    Returns:
    
    phone
  - setPhone
```
public void setPhone(Phone phone)
```
  - getConsentHistories
```
public Map<String,List<UserConsentHistory>> getConsentHistories()
```
    A complete historical record of all the user's consents and withdrawals of consent for all studies in the app.
    
    Returns:
    
    consentHistories
  - getEnrollments
```
public Map<String,EnrollmentInfo> getEnrollments()
```
    Records of every enrollment (whether withdrawn or not) in every study for this participant. The key of this mapping is the studyId, and the value is the record of the enrollment.
    
    Returns:
    
    enrollments
  - consented
```
public StudyParticipant consented(Boolean consented)
```
  - isConsented
```
public Boolean isConsented()
```
    True if the user has consented to all required consents, based on the user's most recent request info (client info, languages, data groups). May be null if this object was not constructed with consent histories, or if consent status is indeterminate.
    
    Returns:
    
    consented
  - setConsented
```
public void setConsented(Boolean consented)
```
  - timeZone
```
public StudyParticipant timeZone(String timeZone)
```
  - getTimeZone
```
public String getTimeZone()
```
    User's original time zone, as measured by the timezone used to request activities, as a string offset in ISO8601 format. Related to the v3 scheduling API, it is not always set or reliable.
    
    Returns:
    
    timeZone
  - setTimeZone
```
public void setTimeZone(String timeZone)
```
  - getType
```
public String getType()
```
    StudyParticipant
    
    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

Class StudyParticipant

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StudyParticipant

Method Detail

firstName

getFirstName

setFirstName

lastName

getLastName

setLastName

synapseUserId

getSynapseUserId

setSynapseUserId

getId

notifyByEmail

isNotifyByEmail

setNotifyByEmail

attributes

putAttributesItem

getAttributes

setAttributes

sharingScope

getSharingScope

setSharingScope

getCreatedOn

emailVerified

isEmailVerified

setEmailVerified

phoneVerified

isPhoneVerified

setPhoneVerified

status

getStatus

setStatus

roles

addRolesItem

getRoles

setRoles

dataGroups

addDataGroupsItem

getDataGroups

setDataGroups

clientData

getClientData

setClientData

languages

addLanguagesItem

getLanguages

setLanguages

getStudyIds

externalIds

putExternalIdsItem

getExternalIds

setExternalIds

orgMembership

getOrgMembership

setOrgMembership

note

getNote

setNote

clientTimeZone

getClientTimeZone

setClientTimeZone

getHealthCode

email

getEmail

setEmail

phone

getPhone

setPhone

getConsentHistories

getEnrollments

consented

isConsented

setConsented

timeZone

getTimeZone