org.sagebionetworks.bridge.rest.model

Class ParticipantSchedule

java.lang.Object

org.sagebionetworks.bridge.rest.model.ParticipantSchedule

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

The ParticipantSchedule is similar to the Timeline in structure, but includes the specific dates when this participant should perform each session, based on this participant’s events. Entries in the `schedule` are ordered by `startDate` and `startTime`, and entries that are not available to the participant are not included in the schedule. However, definitions for those sessions are still included in the `sessions`, `assessments`, and `studyBursts` collections for future reference. The schedule is calculated based on the participant’s `clientTimeZone` value which is saved as part of their account record.

Constructor Summary

Constructors

Constructor and Description
ParticipantSchedule()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
ParticipantSchedule	eventTimestamps(Map<String,DateTime> eventTimestamps)
List<AssessmentInfo>	getAssessments() Get assessments
String	getClientTimeZone() An IANA time zone name.
DateTime	getCreatedOn() The date and time this schedule was calculated.
DateRange	getDateRange() Get dateRange
Map<String,DateTime>	getEventTimestamps() The most recent timestamps that are being used to calculate this schedule.
List<ScheduledSession>	getSchedule() Get schedule
List<SessionInfo>	getSessions() Get sessions
List<StudyBurstInfo>	getStudyBursts() Get studyBursts
String	getType() ParticipantSchedule
int	hashCode()
ParticipantSchedule	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

ParticipantSchedule

public ParticipantSchedule()

Method Detail

getCreatedOn

public DateTime getCreatedOn()

The date and time this schedule was calculated.

Returns:

createdOn

getClientTimeZone

public String getClientTimeZone()

An IANA time zone name. Participant's time zone. If no time zone has been set for the participant, the default time zone of the Bridge server will be used and that value will be returned in this field.

Returns:

clientTimeZone

getDateRange

public DateRange getDateRange()

Get dateRange

Returns:

dateRange

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

eventTimestamps

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

putEventTimestampsItem

public ParticipantSchedule putEventTimestampsItem(String key,
                                                  DateTime eventTimestampsItem)

getEventTimestamps

public Map<String,DateTime> getEventTimestamps()

The most recent timestamps that are being used to calculate this schedule. These values are needed to submit new adherence records to the server.

Returns:

eventTimestamps

setEventTimestamps

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

getType

public String getType()

ParticipantSchedule

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