org.sagebionetworks.bridge.rest.model

Class EventStreamAdherenceReport

java.lang.Object

org.sagebionetworks.bridge.rest.model.EventStreamAdherenceReport

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

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

Constructor Summary

Constructors

Constructor and Description
EventStreamAdherenceReport()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Integer	getAdherencePercent() The percentage of all actionable sessions for the entire study that have been successfully completed by the participant, not including sessions that are available but not yet finished.
String	getClientTimeZone() The IANA time zone name of the participant’s time zone.
DayRange	getDayRangeOfAllStreams() Get dayRangeOfAllStreams
ParticipantStudyProgress	getProgression() Get progression
List<EventStream>	getStreams() Get streams
DateTime	getTimestamp() The timestamp used as “the current time” (or “now”) to calculate this report (adjusted to use the `clientTimeZone` of the participant, if that is persisted on the server).
String	getType() EventStreamAdherenceReport
int	hashCode()
Boolean	isActiveOnly() The activeOnly value submitted when requesting this report.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EventStreamAdherenceReport

public EventStreamAdherenceReport()

Method Detail

isActiveOnly

public Boolean isActiveOnly()

The activeOnly value submitted when requesting this report.

Returns:

activeOnly

getTimestamp

public DateTime getTimestamp()

The timestamp used as “the current time” (or “now”) to calculate this report (adjusted to use the `clientTimeZone` of the participant, if that is persisted on the server).

Returns:

timestamp

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

getAdherencePercent

public Integer getAdherencePercent()

The percentage of all actionable sessions for the entire study that have been successfully completed by the participant, not including sessions that are available but not yet finished.

Returns:

adherencePercent

getDayRangeOfAllStreams

public DayRange getDayRangeOfAllStreams()

Get dayRangeOfAllStreams

Returns:

dayRangeOfAllStreams

getProgression

public ParticipantStudyProgress getProgression()

Get progression

Returns:

progression

getStreams

public List<EventStream> getStreams()

Get streams

Returns:

streams

getType

public String getType()

EventStreamAdherenceReport

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