org.sagebionetworks.bridge.rest.model

Class Activity

java.lang.Object

org.sagebionetworks.bridge.rest.model.Activity

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

When creating an activity as part of a Schedule, you will need to supply a SurveyReference or a TaskReference in the activity. When these are returned, any survey reference that points to the \"most recently published\" survey will be resolved to a specific survey revision (the one most recently published). Scheduled activities may be requested into the future by the client, and then cached. So if a survey is changed and published, it may be a few days before participants receive the updated survey.

Constructor Summary

Constructors

Constructor and Description
Activity()

Method Summary

Modifier and Type	Method and Description
Activity	activityType(ActivityType activityType)
Activity	compoundActivity(CompoundActivity compoundActivity)
boolean	equals(Object o)
ActivityType	getActivityType() Get activityType
CompoundActivity	getCompoundActivity() Get compoundActivity
String	getGuid() Get guid
String	getLabel() A label to show the user for this activity.
String	getLabelDetail() Detail information for the activity (common uses have included indicating the number of questions, or the average time it takes to complete the activity).
SurveyReference	getSurvey() Get survey
TaskReference	getTask() Get task
String	getType() Activity
Activity	guid(String guid)
int	hashCode()
Activity	label(String label)
Activity	labelDetail(String labelDetail)
void	setActivityType(ActivityType activityType)
void	setCompoundActivity(CompoundActivity compoundActivity)
void	setGuid(String guid)
void	setLabel(String label)
void	setLabelDetail(String labelDetail)
void	setSurvey(SurveyReference survey)
void	setTask(TaskReference task)
Activity	survey(SurveyReference survey)
Activity	task(TaskReference task)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Activity

public Activity()

Method Detail

label

public Activity label(String label)

getLabel

public String getLabel()

A label to show the user for this activity.

Returns:

label

setLabel

public void setLabel(String label)

labelDetail

public Activity labelDetail(String labelDetail)

getLabelDetail

public String getLabelDetail()

Detail information for the activity (common uses have included indicating the number of questions, or the average time it takes to complete the activity).

Returns:

labelDetail

setLabelDetail

public void setLabelDetail(String labelDetail)

guid

public Activity guid(String guid)

getGuid

public String getGuid()

Get guid

Returns:

guid

setGuid

public void setGuid(String guid)

compoundActivity

public Activity compoundActivity(CompoundActivity compoundActivity)

getCompoundActivity

public CompoundActivity getCompoundActivity()

Get compoundActivity

Returns:

compoundActivity

setCompoundActivity

public void setCompoundActivity(CompoundActivity compoundActivity)

task

public Activity task(TaskReference task)

getTask

public TaskReference getTask()

Get task

Returns:

task

setTask

public void setTask(TaskReference task)

survey

public Activity survey(SurveyReference survey)

getSurvey

public SurveyReference getSurvey()

Get survey

Returns:

survey

setSurvey

public void setSurvey(SurveyReference survey)

activityType

public Activity activityType(ActivityType activityType)

getActivityType

public ActivityType getActivityType()

Get activityType

Returns:

activityType

setActivityType

public void setActivityType(ActivityType activityType)

getType

public String getType()

Activity

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