org.sagebionetworks.bridge.rest.model

Class ScheduledActivity

java.lang.Object

org.sagebionetworks.bridge.rest.model.ScheduledActivity

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

Description of an activity (such as a task or survey) the study would like the participant to perform. A scheduled activity will contain a reference to a task, a survey, a compound task (which can include any combination of tasks and surveys), and the activityType will reflect which property exists on the scheduled activity object (e.g. if a task is defined, the activityType will be \"task\").

Constructor Summary

Constructors

Constructor and Description
ScheduledActivity()

Method Summary

Modifier and Type	Method and Description
ScheduledActivity	clientData(Object clientData)
boolean	equals(Object o)
ScheduledActivity	finishedOn(DateTime finishedOn)
Activity	getActivity() Get activity
Object	getClientData() An arbitrary object that will be serialized and stored as JSON using the GSON serialization mechanisms.
DateTime	getExpiresOn() The time after which this task should no longer be made available to the participant.
DateTime	getFinishedOn() This field is filled out by the client to persist the fact that a task has been finished.
String	getGuid() Get guid
DateTime	getScheduledOn() The time at which the activity should be made available to the participant.
String	getSchedulePlanGuid() Get schedulePlanGuid
DateTime	getStartedOn() This field is filled out by the client to persist the fact that a task has been started.
ScheduleStatus	getStatus() Get status
String	getType() ScheduledActivity
ScheduledActivity	guid(String guid)
int	hashCode()
Boolean	isPersistent() Is this activity persistent? If so, it will never be removed from the list of activities; the client may wish to provide different UI for such a task.
void	setClientData(Object clientData)
void	setFinishedOn(DateTime finishedOn)
void	setGuid(String guid)
void	setStartedOn(DateTime startedOn)
void	setStatus(ScheduleStatus status)
ScheduledActivity	startedOn(DateTime startedOn)
ScheduledActivity	status(ScheduleStatus status)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ScheduledActivity

public ScheduledActivity()

Method Detail

guid

public ScheduledActivity guid(String guid)

getGuid

public String getGuid()

Get guid

Returns:

guid

setGuid

public void setGuid(String guid)

getSchedulePlanGuid

public String getSchedulePlanGuid()

Get schedulePlanGuid

Returns:

schedulePlanGuid

startedOn

public ScheduledActivity startedOn(DateTime startedOn)

getStartedOn

public DateTime getStartedOn()

This field is filled out by the client to persist the fact that a task has been started. Started on is always reported in UTC, regardless of the time zone being used to express the scheduling window (scheduledOn to expiresOn).

Returns:

startedOn

setStartedOn

public void setStartedOn(DateTime startedOn)

finishedOn

public ScheduledActivity finishedOn(DateTime finishedOn)

getFinishedOn

public DateTime getFinishedOn()

This field is filled out by the client to persist the fact that a task has been finished. To delete a task, record a finishedOn timestamp and leave the startedOn field blank. Finished on is always reported in UTC, regardless of the time zone being used to express the scheduling window (scheduledOn to expiresOn).

Returns:

finishedOn

setFinishedOn

public void setFinishedOn(DateTime finishedOn)

getScheduledOn

public DateTime getScheduledOn()

The time at which the activity should be made available to the participant. It's fine to show the activity before this, but the user should not be able to start it until this time has passed. Time will be expressed in the time zone sent to the server to request the scheduled activities.

Returns:

scheduledOn

getExpiresOn

public DateTime getExpiresOn()

The time after which this task should no longer be made available to the participant. It will also no longer be returned from the server API. Time will be expressed in the time zone sent to the server to request the scheduled activities.

Returns:

expiresOn

getActivity

public Activity getActivity()

Get activity

Returns:

activity

isPersistent

public Boolean isPersistent()

Is this activity persistent? If so, it will never be removed from the list of activities; the client may wish to provide different UI for such a task.

Returns:

persistent

clientData

public ScheduledActivity clientData(Object clientData)

getClientData

public Object getClientData()

An arbitrary object that will be serialized and stored as JSON using the GSON serialization mechanisms. In Java this field is an Object; since the type of the object is not known, the rest-client includes a utility method: ``` MyCustomObject data = RestUtils.toType( activity.getClientData(), MyCustomObject.class); ```

Returns:

clientData

setClientData

public void setClientData(Object clientData)

status

public ScheduledActivity status(ScheduleStatus status)

getStatus

public ScheduleStatus getStatus()

Get status

Returns:

status

setStatus

public void setStatus(ScheduleStatus status)

getType

public String getType()

ScheduledActivity

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