Study (REST Client 0.25.15 API)

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

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

A study (an outside organization providing participants for a study).

Constructor Summary

Constructors
Constructor and Description

Study()

Constructors
Constructor and Description
`Study()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Study`	`addContactsItem(Contact contactsItem)`
`Study`	`addCustomEventsItem(CustomEvent customEventsItem)`
`Study`	`addDiseasesItem(String diseasesItem)`
`Study`	`addSignInTypesItem(SignInType signInTypesItem)`
`Study`	`addStudyDesignTypesItem(String studyDesignTypesItem)`
`Study`	`adherenceThresholdPercentage(Integer adherenceThresholdPercentage)`
`Study`	`clientData(Object clientData)`
`Study`	`colorScheme(ColorScheme colorScheme)`
`Study`	`contacts(List<Contact> contacts)`
`Study`	`customEvents(List<CustomEvent> customEvents)`
`Study`	`deleted(Boolean deleted)`
`Study`	`details(String details)`
`Study`	`diseases(List<String> diseases)`
`boolean`	`equals(Object o)`
`Study`	`exporter3Configuration(Exporter3Configuration exporter3Configuration)`
`Study`	`exporter3Enabled(Boolean exporter3Enabled)`
`Integer`	`getAdherenceThresholdPercentage()` If a participant’s adherence percentage drops under the adherence threshold percentage, Bridge will take action (for example, send a message to administrators for follow-up).
`Object`	`getClientData()` Client data for a study should be in a syntactically valid JSON format.
`ColorScheme`	`getColorScheme()` Get colorScheme
`List<Contact>`	`getContacts()` Get contacts
`DateTime`	`getCreatedOn()` The date and time the study was created.
`List<CustomEvent>`	`getCustomEvents()` Get customEvents
`String`	`getDetails()` An in-depth description of this study for prospective participants, or to show participants after they have joined a study (the “about” screen for the study).
`List<String>`	`getDiseases()` A list of the diseases that are the subject of this study.
`Exporter3Configuration`	`getExporter3Configuration()` Configuration required for Exporter 3.0.
`String`	`getIdentifier()` The identifier for this study.
`String`	`getInstitutionId()` An identification number for the study that has been assigned by the sponsor or institution running the study.
`LocalDate`	`getIrbDecisionOn()` Before the study can launch, it must be reviewed by your IRB and either be approved, or considered exempt from human subjects research guidelines.
`IrbDecisionType`	`getIrbDecisionType()` Get irbDecisionType
`LocalDate`	`getIrbExpiresOn()` The last date that the IRB’s review is considered up-to-date for this study.
`String`	`getIrbName()` The name of the IRB that approved the study or decided it was exempt from human subjects research guidelines.
`String`	`getIrbProtocolId()` An identification number for the study that has been assigned by the IRB.
`String`	`getIrbProtocolName()` The name of the protocol as it was submitted to the IRB for approval.
`String`	`getKeywords()` Free text that can be used in searches to locate studies.
`DateTime`	`getModifiedOn()` The date and time the study was last modified.
`String`	`getName()` The name of the study.
`StudyPhase`	`getPhase()` The lifecycle phase this study is in.
`String`	`getScheduleGuid()` The GUID of the schedule to use for this study.
`List<SignInType>`	`getSignInTypes()` Get signInTypes
`List<String>`	`getStudyDesignTypes()` The type of study (e.g.
`String`	`getStudyLogoUrl()` An URL to a logo for the study.
`String`	`getStudyStartEventId()` The event that starts the study for a participant.
`String`	`getStudyTimeZone()` The time zone of the study.
`String`	`getType()` Study
`Long`	`getVersion()` The optimistic locking version of the study.
`int`	`hashCode()`
`Study`	`identifier(String identifier)`
`Study`	`institutionId(String institutionId)`
`Study`	`irbDecisionOn(LocalDate irbDecisionOn)`
`Study`	`irbDecisionType(IrbDecisionType irbDecisionType)`
`Study`	`irbExpiresOn(LocalDate irbExpiresOn)`
`Study`	`irbName(String irbName)`
`Study`	`irbProtocolId(String irbProtocolId)`
`Study`	`irbProtocolName(String irbProtocolName)`
`Boolean`	`isDeleted()` Has this study been logically deleted (an admin can restore it)?
`Boolean`	`isExporter3Enabled()` True if Exporter 3.0 is enabled for this study.
`Study`	`keywords(String keywords)`
`Study`	`name(String name)`
`Study`	`phase(StudyPhase phase)`
`void`	`setAdherenceThresholdPercentage(Integer adherenceThresholdPercentage)`
`void`	`setClientData(Object clientData)`
`void`	`setColorScheme(ColorScheme colorScheme)`
`void`	`setContacts(List<Contact> contacts)`
`void`	`setCustomEvents(List<CustomEvent> customEvents)`
`void`	`setDeleted(Boolean deleted)`
`void`	`setDetails(String details)`
`void`	`setDiseases(List<String> diseases)`
`void`	`setExporter3Configuration(Exporter3Configuration exporter3Configuration)`
`void`	`setExporter3Enabled(Boolean exporter3Enabled)`
`void`	`setIdentifier(String identifier)`
`void`	`setInstitutionId(String institutionId)`
`void`	`setIrbDecisionOn(LocalDate irbDecisionOn)`
`void`	`setIrbDecisionType(IrbDecisionType irbDecisionType)`
`void`	`setIrbExpiresOn(LocalDate irbExpiresOn)`
`void`	`setIrbName(String irbName)`
`void`	`setIrbProtocolId(String irbProtocolId)`
`void`	`setIrbProtocolName(String irbProtocolName)`
`void`	`setKeywords(String keywords)`
`void`	`setName(String name)`
`void`	`setPhase(StudyPhase phase)`
`void`	`setSignInTypes(List<SignInType> signInTypes)`
`void`	`setStudyDesignTypes(List<String> studyDesignTypes)`
`void`	`setStudyLogoUrl(String studyLogoUrl)`
`void`	`setStudyStartEventId(String studyStartEventId)`
`void`	`setStudyTimeZone(String studyTimeZone)`
`void`	`setVersion(Long version)`
`Study`	`signInTypes(List<SignInType> signInTypes)`
`Study`	`studyDesignTypes(List<String> studyDesignTypes)`
`Study`	`studyLogoUrl(String studyLogoUrl)`
`Study`	`studyStartEventId(String studyStartEventId)`
`Study`	`studyTimeZone(String studyTimeZone)`
`String`	`toString()`
`Study`	`version(Long version)`

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

- Constructor Detail
  - Study
```
public Study()
```
- Method Detail
  - identifier
```
public Study identifier(String identifier)
```
  - getIdentifier
```
public String getIdentifier()
```
    The identifier for this study.
    
    Returns:
    
    identifier
  - setIdentifier
```
public void setIdentifier(String identifier)
```
  - name
```
public Study name(String name)
```
  - getName
```
public String getName()
```
    The name of the study.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - details
```
public Study details(String details)
```
  - getDetails
```
public String getDetails()
```
    An in-depth description of this study for prospective participants, or to show participants after they have joined a study (the “about” screen for the study).
    
    Returns:
    
    details
  - setDetails
```
public void setDetails(String details)
```
  - exporter3Configuration
```
public Study exporter3Configuration(Exporter3Configuration exporter3Configuration)
```
  - getExporter3Configuration
```
public Exporter3Configuration getExporter3Configuration()
```
    Configuration required for Exporter 3.0.
    
    Returns:
    
    exporter3Configuration
  - setExporter3Configuration
```
public void setExporter3Configuration(Exporter3Configuration exporter3Configuration)
```
  - exporter3Enabled
```
public Study exporter3Enabled(Boolean exporter3Enabled)
```
  - isExporter3Enabled
```
public Boolean isExporter3Enabled()
```
    True if Exporter 3.0 is enabled for this study.
    
    Returns:
    
    exporter3Enabled
  - setExporter3Enabled
```
public void setExporter3Enabled(Boolean exporter3Enabled)
```
  - phase
```
public Study phase(StudyPhase phase)
```
  - getPhase
```
public StudyPhase getPhase()
```
    The lifecycle phase this study is in.
    
    Returns:
    
    phase
  - setPhase
```
public void setPhase(StudyPhase phase)
```
  - studyStartEventId
```
public Study studyStartEventId(String studyStartEventId)
```
  - getStudyStartEventId
```
public String getStudyStartEventId()
```
    The event that starts the study for a participant. This must be a system event ID or a custom event ID for the study. If not set, Bridge will use the first time the participant requests their timeline or schedule (`timeline_retrieved`).
    
    Returns:
    
    studyStartEventId
  - setStudyStartEventId
```
public void setStudyStartEventId(String studyStartEventId)
```
  - clientData
```
public Study clientData(Object clientData)
```
  - getClientData
```
public Object getClientData()
```
    Client data for a study should be in a syntactically valid JSON format. It will be returned as is to the client (as JSON). It can contain any information that is useful to study authoring tools or administration tools that is not part of the Bridge data model.
    
    Returns:
    
    clientData
  - setClientData
```
public void setClientData(Object clientData)
```
  - studyTimeZone
```
public Study studyTimeZone(String studyTimeZone)
```
  - getStudyTimeZone
```
public String getStudyTimeZone()
```
    The time zone of the study. Reports for this study (including adherence reporting) will be run by Bridge based on this time zone. Must be an IANA time zone name.
    
    Returns:
    
    studyTimeZone
  - setStudyTimeZone
```
public void setStudyTimeZone(String studyTimeZone)
```
  - adherenceThresholdPercentage
```
public Study adherenceThresholdPercentage(Integer adherenceThresholdPercentage)
```
  - getAdherenceThresholdPercentage
```
public Integer getAdherenceThresholdPercentage()
```
    If a participant’s adherence percentage drops under the adherence threshold percentage, Bridge will take action (for example, send a message to administrators for follow-up). minimum: 0 maximum: 100
    
    Returns:
    
    adherenceThresholdPercentage
  - setAdherenceThresholdPercentage
```
public void setAdherenceThresholdPercentage(Integer adherenceThresholdPercentage)
```
  - irbName
```
public Study irbName(String irbName)
```
  - getIrbName
```
public String getIrbName()
```
    The name of the IRB that approved the study or decided it was exempt from human subjects research guidelines. Optional, but can be used to identify one of several IRBs if more than one is included in the study’s contact information.
    
    Returns:
    
    irbName
  - setIrbName
```
public void setIrbName(String irbName)
```
  - irbDecisionOn
```
public Study irbDecisionOn(LocalDate irbDecisionOn)
```
  - getIrbDecisionOn
```
public LocalDate getIrbDecisionOn()
```
    Before the study can launch, it must be reviewed by your IRB and either be approved, or considered exempt from human subjects research guidelines.
    
    Returns:
    
    irbDecisionOn
  - setIrbDecisionOn
```
public void setIrbDecisionOn(LocalDate irbDecisionOn)
```
  - irbExpiresOn
```
public Study irbExpiresOn(LocalDate irbExpiresOn)
```
  - getIrbExpiresOn
```
public LocalDate getIrbExpiresOn()
```
    The last date that the IRB’s review is considered up-to-date for this study.
    
    Returns:
    
    irbExpiresOn
  - setIrbExpiresOn
```
public void setIrbExpiresOn(LocalDate irbExpiresOn)
```
  - irbDecisionType
```
public Study irbDecisionType(IrbDecisionType irbDecisionType)
```
  - getIrbDecisionType
```
public IrbDecisionType getIrbDecisionType()
```
    Get irbDecisionType
    
    Returns:
    
    irbDecisionType
  - setIrbDecisionType
```
public void setIrbDecisionType(IrbDecisionType irbDecisionType)
```
  - irbProtocolName
```
public Study irbProtocolName(String irbProtocolName)
```
  - getIrbProtocolName
```
public String getIrbProtocolName()
```
    The name of the protocol as it was submitted to the IRB for approval.
    
    Returns:
    
    irbProtocolName
  - setIrbProtocolName
```
public void setIrbProtocolName(String irbProtocolName)
```
  - irbProtocolId
```
public Study irbProtocolId(String irbProtocolId)
```
  - getIrbProtocolId
```
public String getIrbProtocolId()
```
    An identification number for the study that has been assigned by the IRB.
    
    Returns:
    
    irbProtocolId
  - setIrbProtocolId
```
public void setIrbProtocolId(String irbProtocolId)
```
  - studyLogoUrl
```
public Study studyLogoUrl(String studyLogoUrl)
```
  - getStudyLogoUrl
```
public String getStudyLogoUrl()
```
    An URL to a logo for the study.
    
    Returns:
    
    studyLogoUrl
  - setStudyLogoUrl
```
public void setStudyLogoUrl(String studyLogoUrl)
```
  - colorScheme
```
public Study colorScheme(ColorScheme colorScheme)
```
  - getColorScheme
```
public ColorScheme getColorScheme()
```
    Get colorScheme
    
    Returns:
    
    colorScheme
  - setColorScheme
```
public void setColorScheme(ColorScheme colorScheme)
```
  - institutionId
```
public Study institutionId(String institutionId)
```
  - getInstitutionId
```
public String getInstitutionId()
```
    An identification number for the study that has been assigned by the sponsor or institution running the study.
    
    Returns:
    
    institutionId
  - setInstitutionId
```
public void setInstitutionId(String institutionId)
```
  - getScheduleGuid
```
public String getScheduleGuid()
```
    The GUID of the schedule to use for this study. **NOTE: this is temporary, and will be replaced with a model of the study protocol that can include multiple arms in the study.**
    
    Returns:
    
    scheduleGuid
  - keywords
```
public Study keywords(String keywords)
```
  - getKeywords
```
public String getKeywords()
```
    Free text that can be used in searches to locate studies.
    
    Returns:
    
    keywords
  - setKeywords
```
public void setKeywords(String keywords)
```
  - diseases
```
public Study diseases(List<String> diseases)
```
  - addDiseasesItem
```
public Study addDiseasesItem(String diseasesItem)
```
  - getDiseases
```
public List<String> getDiseases()
```
    A list of the diseases that are the subject of this study.
    
    Returns:
    
    diseases
  - setDiseases
```
public void setDiseases(List<String> diseases)
```
  - studyDesignTypes
```
public Study studyDesignTypes(List<String> studyDesignTypes)
```
  - addStudyDesignTypesItem
```
public Study addStudyDesignTypesItem(String studyDesignTypesItem)
```
  - getStudyDesignTypes
```
public List<String> getStudyDesignTypes()
```
    The type of study (e.g. observational, interventional, etc.).
    
    Returns:
    
    studyDesignTypes
  - setStudyDesignTypes
```
public void setStudyDesignTypes(List<String> studyDesignTypes)
```
  - signInTypes
```
public Study signInTypes(List<SignInType> signInTypes)
```
  - addSignInTypesItem
```
public Study addSignInTypesItem(SignInType signInTypesItem)
```
  - getSignInTypes
```
public List<SignInType> getSignInTypes()
```
    Get signInTypes
    
    Returns:
    
    signInTypes
  - setSignInTypes
```
public void setSignInTypes(List<SignInType> signInTypes)
```
  - contacts
```
public Study contacts(List<Contact> contacts)
```
  - addContactsItem
```
public Study addContactsItem(Contact contactsItem)
```
  - getContacts
```
public List<Contact> getContacts()
```
    Get contacts
    
    Returns:
    
    contacts
  - setContacts
```
public void setContacts(List<Contact> contacts)
```
  - customEvents
```
public Study customEvents(List<CustomEvent> customEvents)
```
  - addCustomEventsItem
```
public Study addCustomEventsItem(CustomEvent customEventsItem)
```
  - getCustomEvents
```
public List<CustomEvent> getCustomEvents()
```
    Get customEvents
    
    Returns:
    
    customEvents
  - setCustomEvents
```
public void setCustomEvents(List<CustomEvent> customEvents)
```
  - deleted
```
public Study deleted(Boolean deleted)
```
  - isDeleted
```
public Boolean isDeleted()
```
    Has this study been logically deleted (an admin can restore it)?
    
    Returns:
    
    deleted
  - setDeleted
```
public void setDeleted(Boolean deleted)
```
  - getCreatedOn
```
public DateTime getCreatedOn()
```
    The date and time the study was created.
    
    Returns:
    
    createdOn
  - getModifiedOn
```
public DateTime getModifiedOn()
```
    The date and time the study was last modified.
    
    Returns:
    
    modifiedOn
  - version
```
public Study version(Long version)
```
  - getVersion
```
public Long getVersion()
```
    The optimistic locking version of the study. 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. It can also serve as a key to determine if a local cache of this `Study` revision needs to be updated.
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(Long version)
```
  - getType
```
public String getType()
```
    Study
    
    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 Study

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Study

Method Detail

identifier

getIdentifier

setIdentifier

name

getName

setName

details

getDetails

setDetails

exporter3Configuration

getExporter3Configuration

setExporter3Configuration

exporter3Enabled

isExporter3Enabled

setExporter3Enabled

phase

getPhase

setPhase

studyStartEventId

getStudyStartEventId

setStudyStartEventId

clientData

getClientData

setClientData

studyTimeZone

getStudyTimeZone

setStudyTimeZone

adherenceThresholdPercentage

getAdherenceThresholdPercentage

setAdherenceThresholdPercentage

irbName

getIrbName

setIrbName

irbDecisionOn

getIrbDecisionOn

setIrbDecisionOn

irbExpiresOn

getIrbExpiresOn

setIrbExpiresOn

irbDecisionType

getIrbDecisionType

setIrbDecisionType

irbProtocolName

getIrbProtocolName

setIrbProtocolName

irbProtocolId

getIrbProtocolId

setIrbProtocolId

studyLogoUrl

getStudyLogoUrl

setStudyLogoUrl

colorScheme

getColorScheme

setColorScheme

institutionId

getInstitutionId

setInstitutionId

getScheduleGuid

keywords

getKeywords

setKeywords

diseases

addDiseasesItem

getDiseases

setDiseases

studyDesignTypes

addStudyDesignTypesItem

getStudyDesignTypes

setStudyDesignTypes

signInTypes

addSignInTypesItem

getSignInTypes

setSignInTypes