org.sagebionetworks.bridge.rest.model

Class StudyAdherenceReport

java.lang.Object

org.sagebionetworks.bridge.rest.model.StudyAdherenceReport

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

A report on one participant’s adherence to a study’s entire schedule protocol.

Constructor Summary

Constructors

Constructor and Description
StudyAdherenceReport()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
StudyAdherenceReport	eventTimestamps(Map<String,DateTime> eventTimestamps)
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.
String	getClientTimeZone() The IANA time zone name of the participant’s time zone.
DateTime	getCreatedOn() ISO 8601 date and time that the report was generated.
DateRange	getDateRange() Get dateRange
Map<String,DateTime>	getEventTimestamps() A mapping of event IDs to the most recent timestamp value for that event.
AccountRef	getParticipant() Get participant
ParticipantStudyProgress	getProgression() Get progression
String	getType() StudyAdherenceReport
List<String>	getUnscheduledSessions() Get unscheduledSessions
List<String>	getUnsetEventIds() Get unsetEventIds
List<StudyReportWeek>	getWeeks() Get weeks
int	hashCode()
Boolean	isTestAccount() Will be true if the account is a test account, with the “test_user” data group assigned to it.
StudyAdherenceReport	putEventTimestampsItem(String key, DateTime eventTimestampsItem)
void	setEventTimestamps(Map<String,DateTime> eventTimestamps)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StudyAdherenceReport

public StudyAdherenceReport()

Method Detail

getParticipant

public AccountRef getParticipant()

Get participant

Returns:

participant

isTestAccount

public Boolean isTestAccount()

Will be true if the account is a test account, with the “test_user” data group assigned to it. Developer roles without access to production accounts can only see test accounts regardless of their API query.

Returns:

testAccount

getProgression

public ParticipantStudyProgress getProgression()

Get progression

Returns:

progression

getDateRange

public DateRange getDateRange()

Get dateRange

Returns:

dateRange

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

getClientTimeZone

public String getClientTimeZone()

The IANA time zone name of the participant’s time zone. This value, if it has been persisted for the account, will be used for time calculations of the report on the server.

Returns:

clientTimeZone

getCreatedOn

public DateTime getCreatedOn()

ISO 8601 date and time that the report was generated. The current week is cached as the weekly report when this full report is requested.

Returns:

createdOn

getWeeks

public List<StudyReportWeek> getWeeks()

Get weeks

Returns:

weeks

getUnsetEventIds

public List<String> getUnsetEventIds()

Get unsetEventIds

Returns:

unsetEventIds

getUnscheduledSessions

public List<String> getUnscheduledSessions()

Get unscheduledSessions

Returns:

unscheduledSessions

eventTimestamps

public StudyAdherenceReport eventTimestamps(Map<String,DateTime> eventTimestamps)

putEventTimestampsItem

public StudyAdherenceReport putEventTimestampsItem(String key,
                                                   DateTime eventTimestampsItem)

getEventTimestamps

public Map<String,DateTime> getEventTimestamps()

A mapping of event IDs to the most recent timestamp value for that event. This value is necessary to submit adherence records to the server.

Returns:

eventTimestamps

setEventTimestamps

public void setEventTimestamps(Map<String,DateTime> eventTimestamps)

getType

public String getType()

StudyAdherenceReport

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