org.sagebionetworks.bridge.rest.model

Class Timeline

java.lang.Object

org.sagebionetworks.bridge.rest.model.Timeline

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

A detailed description of when a participant should perform specific sessions and assessments as part of a study, along with the metadata to show UI to the participant before loading and executing code for the assessments.

Constructor Summary

Constructors

Constructor and Description
Timeline()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<AssessmentInfo>	getAssessments() Get assessments
String	getDuration() The length of time of the study’s protocol, after which the participant has completed the study.
List<ScheduledSession>	getSchedule() Get schedule
List<SessionInfo>	getSessions() Get sessions
List<StudyBurstInfo>	getStudyBursts() Get studyBursts
Integer	getTotalMinutes() The total number of minutes to perform all the sessions in the timeline.
Integer	getTotalNotifications() The total number of notifications that could be shown to the participant (if all possible notifications are shown; fewer notifications may be shown since the participant may complete sessions before all reminders are shown for the session).
String	getType() Timeline
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Timeline

public Timeline()

Method Detail

getDuration

public String getDuration()

The length of time of the study’s protocol, after which the participant has completed the study. Events in the timeline will not extend past this duration in time.

Returns:

duration

getSchedule

public List<ScheduledSession> getSchedule()

Get schedule

Returns:

schedule

getAssessments

public List<AssessmentInfo> getAssessments()

Get assessments

Returns:

assessments

getSessions

public List<SessionInfo> getSessions()

Get sessions

Returns:

sessions

getStudyBursts

public List<StudyBurstInfo> getStudyBursts()

Get studyBursts

Returns:

studyBursts

getTotalMinutes

public Integer getTotalMinutes()

The total number of minutes to perform all the sessions in the timeline. This information is provided for informational purposes to schedule designers.

Returns:

totalMinutes

getTotalNotifications

public Integer getTotalNotifications()

The total number of notifications that could be shown to the participant (if all possible notifications are shown; fewer notifications may be shown since the participant may complete sessions before all reminders are shown for the session). This information is provided for informational purposes to schedule designers.

Returns:

totalNotifications

getType

public String getType()

Timeline

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