org.sagebionetworks.bridge.rest.model

Class StudyReportWeek

java.lang.Object

org.sagebionetworks.bridge.rest.model.StudyReportWeek

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

One week of activities to be performed in this study by the participant, measuring weeks from the `studyStartEventId` of the study if it exists for the user (this defaults to `timeline_retrieved` for studies that do not define another event), or the first event the scheduler can find for the participant that is used by the schedule if `studyStartEventId` does not exist for the participant.

Constructor Summary

Constructors

Constructor and Description
StudyReportWeek()

Method Summary

Modifier and Type	Method and Description
StudyReportWeek	addRowsItem(WeeklyAdherenceReportRow rowsItem)
boolean	equals(Object o)
Integer	getAdherencePercent() The percentage of actionable sessions that have been successfully completed by the participant for the whole study, rounded down to the nearest percent.
Map<String,List<EventStreamDay>>	getByDayEntries() A map of activities to be performed at specific days (in this case, of one week, or 0-6 days of the week).
List<WeeklyAdherenceReportRow>	getRows() Get rows
LocalDate	getStartDate() Get startDate
String	getType() StudyReportWeek
Integer	getWeekInStudy() Get weekInStudy
int	hashCode()
StudyReportWeek	rows(List<WeeklyAdherenceReportRow> rows)
void	setRows(List<WeeklyAdherenceReportRow> rows)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StudyReportWeek

public StudyReportWeek()

Method Detail

getWeekInStudy

public Integer getWeekInStudy()

Get weekInStudy

Returns:

weekInStudy

getStartDate

public LocalDate getStartDate()

Get startDate

Returns:

startDate

getAdherencePercent

public Integer getAdherencePercent()

The percentage of actionable sessions that have been successfully completed by the participant for the whole study, rounded down to the nearest percent. Only sessions that have been completed are considered to be in adherence.

Returns:

adherencePercent

rows

public StudyReportWeek rows(List<WeeklyAdherenceReportRow> rows)

addRowsItem

public StudyReportWeek addRowsItem(WeeklyAdherenceReportRow rowsItem)

getRows

public List<WeeklyAdherenceReportRow> getRows()

Get rows

Returns:

rows

setRows

public void setRows(List<WeeklyAdherenceReportRow> rows)

getByDayEntries

public Map<String,List<EventStreamDay>> getByDayEntries()

A map of activities to be performed at specific days (in this case, of one week, or 0-6 days of the week). The keys are string integers that correspond to the day on which activities occur, and the value is a detailed description of the activities to be performed on that day.

Returns:

byDayEntries

getType

public String getType()

StudyReportWeek

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