org.sagebionetworks.bridge.rest.model

Class SurveyQuestionOption

java.lang.Object

org.sagebionetworks.bridge.rest.model.SurveyQuestionOption

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

For questions with a list of enumerated answers, this object represents one of those answers.

Constructor Summary

Constructors

Constructor and Description
SurveyQuestionOption()

Method Summary

Modifier and Type	Method and Description
SurveyQuestionOption	detail(String detail)
boolean	equals(Object o)
SurveyQuestionOption	exclusive(Boolean exclusive)
String	getDetail() Detail text shown in a de-emphasized way near the label in the UI (must be plain text).
Image	getImage() An optional Image element describing an image to show for this option.
String	getLabel() The text to show in the UI (must be plain text).
String	getType() SurveyQuestionOption
String	getValue() The value to submit when this option is selected.
int	hashCode()
SurveyQuestionOption	image(Image image)
Boolean	isExclusive() If this option is selected, deselect all other options in the question.
SurveyQuestionOption	label(String label)
void	setDetail(String detail)
void	setExclusive(Boolean exclusive)
void	setImage(Image image)
void	setLabel(String label)
void	setValue(String value)
String	toString()
SurveyQuestionOption	value(String value)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SurveyQuestionOption

public SurveyQuestionOption()

Method Detail

label

public SurveyQuestionOption label(String label)

getLabel

public String getLabel()

The text to show in the UI (must be plain text).

Returns:

label

setLabel

public void setLabel(String label)

detail

public SurveyQuestionOption detail(String detail)

getDetail

public String getDetail()

Detail text shown in a de-emphasized way near the label in the UI (must be plain text).

Returns:

detail

setDetail

public void setDetail(String detail)

value

public SurveyQuestionOption value(String value)

getValue

public String getValue()

The value to submit when this option is selected. The value is always a string, but should be convertible to the data type of the question's constraints. If no value is provided, than the label should be sent as the answer to the surver.

Returns:

value

setValue

public void setValue(String value)

image

public SurveyQuestionOption image(Image image)

getImage

public Image getImage()

An optional Image element describing an image to show for this option. It should be shown along with the label (which will still be required).

Returns:

image

setImage

public void setImage(Image image)

exclusive

public SurveyQuestionOption exclusive(Boolean exclusive)

isExclusive

public Boolean isExclusive()

If this option is selected, deselect all other options in the question. This is used for a \"none of the above\" type option in multiple choice questions.

Returns:

exclusive

setExclusive

public void setExclusive(Boolean exclusive)

getType

public String getType()

SurveyQuestionOption

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