org.sagebionetworks.bridge.rest.model

Class ScheduledSession

java.lang.Object

org.sagebionetworks.bridge.rest.model.ScheduledSession

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

An individual session instance the participant should perform as part of the study. The `refGuid` property will refer to a session in the list of sessions in this timeline. The `instanceGuid` is a unique GUID to identify any data that is generated from the execution of this scheduled session. This allows scientists to contextualize data based on when it was gathered in the execution of the study’s schedule. Further details about how a client should interpret a timeline can be found at the Bridge developer portal.

Constructor Summary

Constructors

Constructor and Description
ScheduledSession()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
List<ScheduledAssessment>	getAssessments() Get assessments
String	getDelayTime() Get delayTime
LocalDate	getEndDate() Only set for the participant schedule.
Integer	getEndDay() The day since the `startEventId` for this session stream when this session should end.
String	getExpiration() Get expiration
String	getInstanceGuid() Get instanceGuid
String	getRefGuid() Get refGuid
LocalDate	getStartDate() Only set for the participant schedule.
Integer	getStartDay() The day since the `startEventId` for this session stream when this session should start.
String	getStartEventId() An event ID for this scheduled session.
String	getStartTime() Get startTime
SessionCompletionState	getState() Only set for the participant schedule (unless the session is persistent; in this case no state is given since the session can be done repeatedly by the participant).
String	getStudyBurstId() Get studyBurstId
Integer	getStudyBurstNum() Get studyBurstNum
String	getTimeWindowGuid() The time window GUID for the time window that generated this scheduled session.
String	getType() ScheduledSession
int	hashCode()
Boolean	isPersistent() Get persistent
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScheduledSession

public ScheduledSession()

Method Detail

getRefGuid

public String getRefGuid()

Get refGuid

Returns:

refGuid

getInstanceGuid

public String getInstanceGuid()

Get instanceGuid

Returns:

instanceGuid

getStartEventId

public String getStartEventId()

An event ID for this scheduled session. The event ID may be mapped to a timestamp for a user. If the event ID does not exist for the user, the client should ignore this scheduled session. Otherwise, it should be shown to the user according to the scheduling information.

Returns:

startEventId

getStartDay

public Integer getStartDay()

The day since the `startEventId` for this session stream when this session should start. Only set for the timeline.

Returns:

startDay

getEndDay

public Integer getEndDay()

The day since the `startEventId` for this session stream when this session should end. Only set for the timeline.

Returns:

endDay

getStartTime

public String getStartTime()

Get startTime

Returns:

startTime

getDelayTime

public String getDelayTime()

Get delayTime

Returns:

delayTime

getExpiration

public String getExpiration()

Get expiration

Returns:

expiration

isPersistent

public Boolean isPersistent()

Get persistent

Returns:

persistent

getStudyBurstId

public String getStudyBurstId()

Get studyBurstId

Returns:

studyBurstId

getStudyBurstNum

public Integer getStudyBurstNum()

Get studyBurstNum

Returns:

studyBurstNum

getTimeWindowGuid

public String getTimeWindowGuid()

The time window GUID for the time window that generated this scheduled session. Only set for the timeline.

Returns:

timeWindowGuid

getAssessments

public List<ScheduledAssessment> getAssessments()

Get assessments

Returns:

assessments

getStartDate

public LocalDate getStartDate()

Only set for the participant schedule.

Returns:

startDate

getEndDate

public LocalDate getEndDate()

Only set for the participant schedule.

Returns:

endDate

getState

public SessionCompletionState getState()

Only set for the participant schedule (unless the session is persistent; in this case no state is given since the session can be done repeatedly by the participant).

Returns:

state

getType

public String getType()

ScheduledSession

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