Subpopulation (REST Client 0.25.28 API)

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

```
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2023-07-13T01:30:51.265Z")
public class Subpopulation
extends Object
```
A subpopulation in the Bridge server is a group of people who, for the purposes of the study, must agree to a specific consent in order to participate in a study. (Some consents can be optional; these will not prevent participants from using Bridge.) For example, a study may have one consent for all participants and a further, optional consent to contribute genetic information. The user must sign the first consent, and may choose to sign the second consent; Bridge will track the status of all this and refuse data from a participant who has not signed all required consents. * Users are assigned to one or more subpopulations on every request; * Bridge verifies that the user has signed all their required consents; * If they have, they are given access to the system. Their session will include detailed information about their consent status; * If the user's consent is not complete, Bridge returns a 412 response (Precondition Not Met). The JSON in that response will include a [UserSessionInfo](#UserSessionInfo) object that contains a summary of the user's consent status. **Note:** filtering on Bridge is **opt-in**: if a request does not include information like a `User-Agent` header, then all subpopulations may be assumed to apply to the caller.

Constructor Summary

Constructors
Constructor and Description

Subpopulation()

Constructors
Constructor and Description
`Subpopulation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Subpopulation`	`addDataGroupsAssignedWhileConsentedItem(String dataGroupsAssignedWhileConsentedItem)`
`Subpopulation`	`addStudyIdsAssignedOnConsentItem(String studyIdsAssignedOnConsentItem)`
`Subpopulation`	`autoSendConsentSuppressed(Boolean autoSendConsentSuppressed)`
`Subpopulation`	`consentHTML(String consentHTML)`
`Subpopulation`	`consentPDF(String consentPDF)`
`Subpopulation`	`criteria(Criteria criteria)`
`Subpopulation`	`dataGroupsAssignedWhileConsented(List<String> dataGroupsAssignedWhileConsented)`
`Subpopulation`	`defaultGroup(Boolean defaultGroup)`
`Subpopulation`	`description(String description)`
`boolean`	`equals(Object o)`
`String`	`getConsentHTML()` The URL to retrieve an HTML version of the published and active version of the consent.
`String`	`getConsentPDF()` The URL to retrieve a PDF version of the published and active version of the consent.
`Criteria`	`getCriteria()` Optional selection criteria that can be used to determine if a user should be assigned to this subpopulation or not.
`List<String>`	`getDataGroupsAssignedWhileConsented()` The data groups that will be assigned to a participant who consents to membership in this subpopulation.
`String`	`getDescription()` The description of this subpopulation.
`String`	`getGuid()` A unique auto-generated identifier for the subpopulation.
`String`	`getName()` The name of this subpopulation.
`DateTime`	`getPublishedConsentCreatedOn()` The creation date (ISO 8601 timestamp) of the version of the consent agreement for this subpopulation that is published, ie.
`List<String>`	`getStudyIdsAssignedOnConsent()` The studies this participant is associated to when they consent to membership in this subpopulation.
`String`	`getType()` Subpopulation
`Long`	`getVersion()` The optimistic locking version of the survey.
`Subpopulation`	`guid(String guid)`
`int`	`hashCode()`
`Boolean`	`isAutoSendConsentSuppressed()` Should the user automatically be sent (via email or SMS) a copy of the consent when they sign it?
`Boolean`	`isDefaultGroup()` If true, this is the default subpopulation created for an app, and it cannot be deleted (although it can be changed, and even made optional or hidden through the use of criteria).
`Boolean`	`isRequired()` If true, participants must sign the consent associated with this subpopulation if they are identified as a member of this subpopulation.
`Subpopulation`	`name(String name)`
`Subpopulation`	`publishedConsentCreatedOn(DateTime publishedConsentCreatedOn)`
`Subpopulation`	`required(Boolean required)`
`void`	`setAutoSendConsentSuppressed(Boolean autoSendConsentSuppressed)`
`void`	`setConsentHTML(String consentHTML)`
`void`	`setConsentPDF(String consentPDF)`
`void`	`setCriteria(Criteria criteria)`
`void`	`setDataGroupsAssignedWhileConsented(List<String> dataGroupsAssignedWhileConsented)`
`void`	`setDefaultGroup(Boolean defaultGroup)`
`void`	`setDescription(String description)`
`void`	`setGuid(String guid)`
`void`	`setName(String name)`
`void`	`setPublishedConsentCreatedOn(DateTime publishedConsentCreatedOn)`
`void`	`setRequired(Boolean required)`
`void`	`setStudyIdsAssignedOnConsent(List<String> studyIdsAssignedOnConsent)`
`void`	`setVersion(Long version)`
`Subpopulation`	`studyIdsAssignedOnConsent(List<String> studyIdsAssignedOnConsent)`
`String`	`toString()`
`Subpopulation`	`version(Long version)`

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

- Constructor Detail
  - Subpopulation
```
public Subpopulation()
```
- Method Detail
  - guid
```
public Subpopulation guid(String guid)
```
  - getGuid
```
public String getGuid()
```
    A unique auto-generated identifier for the subpopulation. Usually a GUID (but not always). Cannot be changed after creation. Used to retrieve the published consent for this subpopulation.
    
    Returns:
    
    guid
  - setGuid
```
public void setGuid(String guid)
```
  - name
```
public Subpopulation name(String name)
```
  - getName
```
public String getName()
```
    The name of this subpopulation.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - description
```
public Subpopulation description(String description)
```
  - getDescription
```
public String getDescription()
```
    The description of this subpopulation.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - criteria
```
public Subpopulation criteria(Criteria criteria)
```
  - getCriteria
```
public Criteria getCriteria()
```
    Optional selection criteria that can be used to determine if a user should be assigned to this subpopulation or not. If the user does not match a subpopulation, then that subpopulation and its requirements are invisible to that user. Otherwise the user is in the subpopulation and all its consent requirements apply.
    
    Returns:
    
    criteria
  - setCriteria
```
public void setCriteria(Criteria criteria)
```
  - autoSendConsentSuppressed
```
public Subpopulation autoSendConsentSuppressed(Boolean autoSendConsentSuppressed)
```
  - isAutoSendConsentSuppressed
```
public Boolean isAutoSendConsentSuppressed()
```
    Should the user automatically be sent (via email or SMS) a copy of the consent when they sign it?
    
    Returns:
    
    autoSendConsentSuppressed
  - setAutoSendConsentSuppressed
```
public void setAutoSendConsentSuppressed(Boolean autoSendConsentSuppressed)
```
  - required
```
public Subpopulation required(Boolean required)
```
  - isRequired
```
public Boolean isRequired()
```
    If true, participants must sign the consent associated with this subpopulation if they are identified as a member of this subpopulation. Users will receive a 412 response from Bridge if this condition is not met.
    
    Returns:
    
    required
  - setRequired
```
public void setRequired(Boolean required)
```
  - defaultGroup
```
public Subpopulation defaultGroup(Boolean defaultGroup)
```
  - isDefaultGroup
```
public Boolean isDefaultGroup()
```
    If true, this is the default subpopulation created for an app, and it cannot be deleted (although it can be changed, and even made optional or hidden through the use of criteria).
    
    Returns:
    
    defaultGroup
  - setDefaultGroup
```
public void setDefaultGroup(Boolean defaultGroup)
```
  - publishedConsentCreatedOn
```
public Subpopulation publishedConsentCreatedOn(DateTime publishedConsentCreatedOn)
```
  - getPublishedConsentCreatedOn
```
public DateTime getPublishedConsentCreatedOn()
```
    The creation date (ISO 8601 timestamp) of the version of the consent agreement for this subpopulation that is published, ie. that is presented to users for their signature. The subpopulation guid and this createdOn timestamp can be used to retrieve the consent document.
    
    Returns:
    
    publishedConsentCreatedOn
  - setPublishedConsentCreatedOn
```
public void setPublishedConsentCreatedOn(DateTime publishedConsentCreatedOn)
```
  - dataGroupsAssignedWhileConsented
```
public Subpopulation dataGroupsAssignedWhileConsented(List<String> dataGroupsAssignedWhileConsented)
```
  - addDataGroupsAssignedWhileConsentedItem
```
public Subpopulation addDataGroupsAssignedWhileConsentedItem(String dataGroupsAssignedWhileConsentedItem)
```
  - getDataGroupsAssignedWhileConsented
```
public List<String> getDataGroupsAssignedWhileConsented()
```
    The data groups that will be assigned to a participant who consents to membership in this subpopulation. If the participant withdraws from this subpopulation, the data groups will be removed from their account.
    
    Returns:
    
    dataGroupsAssignedWhileConsented
  - setDataGroupsAssignedWhileConsented
```
public void setDataGroupsAssignedWhileConsented(List<String> dataGroupsAssignedWhileConsented)
```
  - studyIdsAssignedOnConsent
```
public Subpopulation studyIdsAssignedOnConsent(List<String> studyIdsAssignedOnConsent)
```
  - addStudyIdsAssignedOnConsentItem
```
public Subpopulation addStudyIdsAssignedOnConsentItem(String studyIdsAssignedOnConsentItem)
```
  - getStudyIdsAssignedOnConsent
```
public List<String> getStudyIdsAssignedOnConsent()
```
    The studies this participant is associated to when they consent to membership in this subpopulation. This association is permanent (even if the participant withdraws from the subpopulation, they are still part of the study, visible to study research administrations, and so forth).
    
    Returns:
    
    studyIdsAssignedOnConsent
  - setStudyIdsAssignedOnConsent
```
public void setStudyIdsAssignedOnConsent(List<String> studyIdsAssignedOnConsent)
```
  - version
```
public Subpopulation version(Long version)
```
  - getVersion
```
public Long getVersion()
```
    The optimistic locking version of the survey. This value must be submitted as part of the next update of the model. If it does not match the value on the server, a 409 error (Conflict) will prevent the update from occurring.
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(Long version)
```
  - consentHTML
```
public Subpopulation consentHTML(String consentHTML)
```
  - getConsentHTML
```
public String getConsentHTML()
```
    The URL to retrieve an HTML version of the published and active version of the consent. This can be referenced in your mobile app, web site, etc. Publishing a new consent revision will update this document.
    
    Returns:
    
    consentHTML
  - setConsentHTML
```
public void setConsentHTML(String consentHTML)
```
  - consentPDF
```
public Subpopulation consentPDF(String consentPDF)
```
  - getConsentPDF
```
public String getConsentPDF()
```
    The URL to retrieve a PDF version of the published and active version of the consent. This can be referenced in your mobile app, web site, etc. Publishing a new consent revision will update this document.
    
    Returns:
    
    consentPDF
  - setConsentPDF
```
public void setConsentPDF(String consentPDF)
```
  - getType
```
public String getType()
```
    Subpopulation
    
    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 Subpopulation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Subpopulation

Method Detail

guid

getGuid

setGuid

name

getName

setName

description

getDescription

setDescription

criteria

getCriteria

setCriteria

autoSendConsentSuppressed

isAutoSendConsentSuppressed

setAutoSendConsentSuppressed

required

isRequired

setRequired

defaultGroup

isDefaultGroup

setDefaultGroup

publishedConsentCreatedOn

getPublishedConsentCreatedOn

setPublishedConsentCreatedOn

dataGroupsAssignedWhileConsented

addDataGroupsAssignedWhileConsentedItem

getDataGroupsAssignedWhileConsented

setDataGroupsAssignedWhileConsented

studyIdsAssignedOnConsent

addStudyIdsAssignedOnConsentItem

getStudyIdsAssignedOnConsent

setStudyIdsAssignedOnConsent

version

getVersion

setVersion

consentHTML

getConsentHTML

setConsentHTML

consentPDF

getConsentPDF

setConsentPDF

getType

equals

hashCode

toString