org.sagebionetworks.bridge.rest.model

Class AssessmentInfo

java.lang.Object

org.sagebionetworks.bridge.rest.model.AssessmentInfo

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

Information about an assessment in order to render it in a UI prior to execution.

Constructor Summary

Constructors

Constructor and Description
AssessmentInfo()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getAppId() Get appId
ColorScheme	getColorScheme() Get colorScheme
String	getConfigUrl() The URL to download the configuration associated with this assessment.
String	getGuid() Each assessment revision is assigned a unique GUID which can be used to retrieve it through the API.
String	getIdentifier() A human-readable identifier for an assessment, which can have one or more revisions.
ImageResource	getImageResource() Get imageResource
String	getKey() Because assessments can be configured with different display information, they are not referenced in the schedule portion of a timeline by their GUIDs.
String	getLabel() Get label
Integer	getMinutesToComplete() The number of minutes it takes for a participant to complete this assessment.
Integer	getRevision() The revision of the assessment under the given identifier (the identifier and the revision together are mapped to a single GUID which can be used to reference the assessment; only the GUID is required in this object).
String	getType() AssessmentInfo
int	hashCode()
AssessmentInfo	imageResource(ImageResource imageResource)
void	setImageResource(ImageResource imageResource)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AssessmentInfo

public AssessmentInfo()

Method Detail

getKey

public String getKey()

Because assessments can be configured with different display information, they are not referenced in the schedule portion of a timeline by their GUIDs. Instead they are given a unique string key that is used to look up the assessment.

Returns:

key

getGuid

public String getGuid()

Each assessment revision is assigned a unique GUID which can be used to retrieve it through the API. Assessments will also have a unique combination of an identifier and a revision, and can be retrieved as a set of revisions under a given identifier.

Returns:

guid

getAppId

public String getAppId()

Get appId

Returns:

appId

getIdentifier

public String getIdentifier()

A human-readable identifier for an assessment, which can have one or more revisions.

Returns:

identifier

getRevision

public Integer getRevision()

The revision of the assessment under the given identifier (the identifier and the revision together are mapped to a single GUID which can be used to reference the assessment; only the GUID is required in this object).

Returns:

revision

getLabel

public String getLabel()

Get label

Returns:

label

getMinutesToComplete

public Integer getMinutesToComplete()

The number of minutes it takes for a participant to complete this assessment.

Returns:

minutesToComplete

getColorScheme

public ColorScheme getColorScheme()

Get colorScheme

Returns:

colorScheme

getConfigUrl

public String getConfigUrl()

The URL to download the configuration associated with this assessment.

Returns:

configUrl

imageResource

public AssessmentInfo imageResource(ImageResource imageResource)

getImageResource

public ImageResource getImageResource()

Get imageResource

Returns:

imageResource

setImageResource

public void setImageResource(ImageResource imageResource)

getType

public String getType()

AssessmentInfo

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