org.sagebionetworks.bridge.rest.model

Class Enrollment

java.lang.Object

org.sagebionetworks.bridge.rest.model.Enrollment

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

An enrollment of a user in a study

Constructor Summary

Constructors

Constructor and Description
Enrollment()

Method Summary

Modifier and Type	Method and Description
Enrollment	consentRequired(Boolean consentRequired)
Enrollment	enrolledBy(String enrolledBy)
Enrollment	enrolledOn(DateTime enrolledOn)
boolean	equals(Object o)
Enrollment	externalId(String externalId)
String	getEnrolledBy() If the user is not enrolled through consenting to participate, this will be the user ID of the API caller who enrolled the user in the study (otherwise it is blank).
DateTime	getEnrolledOn() The timestamp of enrollment (either the timestamp of the consent signature if self-enrolled, or the time the enrollment record was created).
String	getExternalId() An optional, arbitrary string identifier that identifies this user in an external system (as a member of this study; one external ID can be tracked per study).
String	getNote() An optional, study-scoped participant note.
String	getType() Enrollment
String	getUserId() The ID of the enrolled user
String	getWithdrawalNote() An optional note that can be supplied by the person doing a withdrawal as to why a participant is being removed from the study.
String	getWithdrawnBy() If the user is not withdrawing their own consent, this will be the user ID of the API caller who withdrew the user (otherwise it is blank).
DateTime	getWithdrawnOn() The timestamp of withdrawal from the study (either the timestamp of the revocation of the consent signature if self-enrolled, or the time the enrollment record was withdrawn).
int	hashCode()
Boolean	isConsentRequired() If true, this user must still sign consents for the study before they can participate.
Enrollment	note(String note)
void	setConsentRequired(Boolean consentRequired)
void	setEnrolledBy(String enrolledBy)
void	setEnrolledOn(DateTime enrolledOn)
void	setExternalId(String externalId)
void	setNote(String note)
void	setUserId(String userId)
void	setWithdrawalNote(String withdrawalNote)
void	setWithdrawnBy(String withdrawnBy)
void	setWithdrawnOn(DateTime withdrawnOn)
String	toString()
Enrollment	userId(String userId)
Enrollment	withdrawalNote(String withdrawalNote)
Enrollment	withdrawnBy(String withdrawnBy)
Enrollment	withdrawnOn(DateTime withdrawnOn)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Enrollment

public Enrollment()

Method Detail

externalId

public Enrollment externalId(String externalId)

getExternalId

public String getExternalId()

An optional, arbitrary string identifier that identifies this user in an external system (as a member of this study; one external ID can be tracked per study).

Returns:

externalId

setExternalId

public void setExternalId(String externalId)

userId

public Enrollment userId(String userId)

getUserId

public String getUserId()

The ID of the enrolled user

Returns:

userId

setUserId

public void setUserId(String userId)

consentRequired

public Enrollment consentRequired(Boolean consentRequired)

isConsentRequired

public Boolean isConsentRequired()

If true, this user must still sign consents for the study before they can participate. Despite this, they are being tracked as part of the study.

Returns:

consentRequired

setConsentRequired

public void setConsentRequired(Boolean consentRequired)

enrolledOn

public Enrollment enrolledOn(DateTime enrolledOn)

getEnrolledOn

public DateTime getEnrolledOn()

The timestamp of enrollment (either the timestamp of the consent signature if self-enrolled, or the time the enrollment record was created).

Returns:

enrolledOn

setEnrolledOn

public void setEnrolledOn(DateTime enrolledOn)

enrolledBy

public Enrollment enrolledBy(String enrolledBy)

getEnrolledBy

public String getEnrolledBy()

If the user is not enrolled through consenting to participate, this will be the user ID of the API caller who enrolled the user in the study (otherwise it is blank).

Returns:

enrolledBy

setEnrolledBy

public void setEnrolledBy(String enrolledBy)

withdrawnOn

public Enrollment withdrawnOn(DateTime withdrawnOn)

getWithdrawnOn

public DateTime getWithdrawnOn()

The timestamp of withdrawal from the study (either the timestamp of the revocation of the consent signature if self-enrolled, or the time the enrollment record was withdrawn).

Returns:

withdrawnOn

setWithdrawnOn

public void setWithdrawnOn(DateTime withdrawnOn)

withdrawnBy

public Enrollment withdrawnBy(String withdrawnBy)

getWithdrawnBy

public String getWithdrawnBy()

If the user is not withdrawing their own consent, this will be the user ID of the API caller who withdrew the user (otherwise it is blank).

Returns:

withdrawnBy

setWithdrawnBy

public void setWithdrawnBy(String withdrawnBy)

withdrawalNote

public Enrollment withdrawalNote(String withdrawalNote)

getWithdrawalNote

public String getWithdrawalNote()

An optional note that can be supplied by the person doing a withdrawal as to why a participant is being removed from the study.

Returns:

withdrawalNote

setWithdrawalNote

public void setWithdrawalNote(String withdrawalNote)

note

public Enrollment note(String note)

getNote

public String getNote()

An optional, study-scoped participant note. Can only be set and accessed by users with administrative roles and access to the study. (eg. Study Coordinators, Researchers, Developers, Study Designers)

Returns:

note

setNote

public void setNote(String note)

getType

public String getType()

Enrollment

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