org.sagebionetworks.bridge.rest.model

Class StudyConsent

java.lang.Object

org.sagebionetworks.bridge.rest.model.StudyConsent

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

For historical reasons, a revision of a consent document is known as a \"study consent\" (it would more accurate to call it a \"subpopulation consent\"). It is a revision of the consent document that is associated with a subpopulation. Subpopulations can be used to group users for several purposes, but the most important use of subpopulations is to divide users into different *consent groups.* **Note:** calls that return lists of these study consents do not populate the `documentContent` property. You must retrieve an individual study consent to get the content of the consent.

Constructor Summary

Constructors

Constructor and Description
StudyConsent()

Method Summary

Modifier and Type	Method and Description
StudyConsent	createdOn(DateTime createdOn)
StudyConsent	documentContent(String documentContent)
boolean	equals(Object o)
DateTime	getCreatedOn() The time the document was created on the server.
String	getDocumentContent() A valid XHTML document describing the consent.
String	getSubpopulationGuid() The guid of the subpopulation to which this consent belongs.
String	getType() StudyConsent
int	hashCode()
void	setCreatedOn(DateTime createdOn)
void	setDocumentContent(String documentContent)
void	setSubpopulationGuid(String subpopulationGuid)
StudyConsent	subpopulationGuid(String subpopulationGuid)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StudyConsent

public StudyConsent()

Method Detail

subpopulationGuid

public StudyConsent subpopulationGuid(String subpopulationGuid)

getSubpopulationGuid

public String getSubpopulationGuid()

The guid of the subpopulation to which this consent belongs.

Returns:

subpopulationGuid

setSubpopulationGuid

public void setSubpopulationGuid(String subpopulationGuid)

createdOn

public StudyConsent createdOn(DateTime createdOn)

getCreatedOn

public DateTime getCreatedOn()

The time the document was created on the server. Each update of the consent document creates a new revision at a new `createdOn` timestamp.

Returns:

createdOn

setCreatedOn

public void setCreatedOn(DateTime createdOn)

documentContent

public StudyConsent documentContent(String documentContent)

getDocumentContent

public String getDocumentContent()

A valid XHTML document describing the consent. In this document, the following tokens can be inserted and they will be substituted with the user's consent information when the consent is requested for that user: |Template variable|Substituted with| |---|---| |${appName}|The name of the app| |${appShortName}|| |${supportEmail}|The support email address for the app| |${technicalEmail}|The technical contact/support email address for the app| |${sponsorName}|The name of the sponsor for this app (the institution or research team name)| |${participantFirstName}|The participant’s first name| |${participantLastName}|The participant’s last name| |${participantEmail}|The participant’s email address| |${participantPhone}|The participant’s phone number in E.164 format (e.g. “+16175551212”)| |${participantPhoneRegion}|The participant’s phone number region code (e.g. “US”)| |${participantPhoneNationalFormat}|The participant’s phone number in a regional format (e.g. “(617) 555-1212”)| The signature block will be appended to the end of your consent document. **It is not possible to remove or change the signature block at this time.**

Returns:

documentContent

setDocumentContent

public void setDocumentContent(String documentContent)

getType

public String getType()

StudyConsent

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