AssessmentReference2 (REST Client 0.25.15 API)

java.lang.Object
- org.sagebionetworks.bridge.rest.model.AssessmentReference2

```
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2022-11-05T00:31:27.098Z")
public class AssessmentReference2
extends Object
```
A pointer to an assessment revision. When a schedule is created, many of these fields should be populated with the default values provided by an `Assessment` (including labels, minutes to complete, and the color scheme). This information is part of the `Schedule` and the `Timeline` so mobile apps can render a UI to access an assessment before it needs to be fully loaded and executed. However, given a particular app’s design, some or all of these values may not be needed, and are not required. These values can then be changed by the study designer as part of the schedule. *As a result however, subsequent updates to the original assessment’s fields will not be reflected in the schedules where the assessment is used.*

Constructor Summary

Constructors
Constructor and Description

AssessmentReference2()

Constructors
Constructor and Description
`AssessmentReference2()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssessmentReference2`	`addLabelsItem(Label labelsItem)`
`AssessmentReference2`	`appId(String appId)`
`AssessmentReference2`	`colorScheme(ColorScheme colorScheme)`
`boolean`	`equals(Object o)`
`String`	`getAppId()` Schedules can refer to assessments in the shared library (appId = shared) or in their own local assessment library (appId will be the appId of the app in which the study is running).
`ColorScheme`	`getColorScheme()` Get colorScheme
`String`	`getGuid()` The assessment revision guid.
`String`	`getIdentifier()` The identifier of the assessment (which stays the same regardless of the revision or GUID of the assessment).
`ImageResource`	`getImageResource()` Get imageResource
`List<Label>`	`getLabels()` A collection of labels for this assessment.
`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`	`getTitle()` A title for this assessment to show to study designers.
`String`	`getType()` AssessmentReference
`AssessmentReference2`	`guid(String guid)`
`int`	`hashCode()`
`AssessmentReference2`	`identifier(String identifier)`
`AssessmentReference2`	`imageResource(ImageResource imageResource)`
`AssessmentReference2`	`labels(List<Label> labels)`
`AssessmentReference2`	`minutesToComplete(Integer minutesToComplete)`
`AssessmentReference2`	`revision(Integer revision)`
`void`	`setAppId(String appId)`
`void`	`setColorScheme(ColorScheme colorScheme)`
`void`	`setGuid(String guid)`
`void`	`setIdentifier(String identifier)`
`void`	`setImageResource(ImageResource imageResource)`
`void`	`setLabels(List<Label> labels)`
`void`	`setMinutesToComplete(Integer minutesToComplete)`
`void`	`setRevision(Integer revision)`
`void`	`setTitle(String title)`
`AssessmentReference2`	`title(String title)`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AssessmentReference2
```
public AssessmentReference2()
```
- Method Detail
  - appId
```
public AssessmentReference2 appId(String appId)
```
  - getAppId
```
public String getAppId()
```
    Schedules can refer to assessments in the shared library (appId = shared) or in their own local assessment library (appId will be the appId of the app in which the study is running).
    
    Returns:
    
    appId
  - setAppId
```
public void setAppId(String appId)
```
  - guid
```
public AssessmentReference2 guid(String guid)
```
  - getGuid
```
public String getGuid()
```
    The assessment revision guid.
    
    Returns:
    
    guid
  - setGuid
```
public void setGuid(String guid)
```
  - title
```
public AssessmentReference2 title(String title)
```
  - getTitle
```
public String getTitle()
```
    A title for this assessment to show to study designers.
    
    Returns:
    
    title
  - setTitle
```
public void setTitle(String title)
```
  - identifier
```
public AssessmentReference2 identifier(String identifier)
```
  - getIdentifier
```
public String getIdentifier()
```
    The identifier of the assessment (which stays the same regardless of the revision or GUID of the assessment). This token can be used, for example, to load an icon for the assessment from an app binary.
    
    Returns:
    
    identifier
  - setIdentifier
```
public void setIdentifier(String identifier)
```
  - revision
```
public AssessmentReference2 revision(Integer revision)
```
  - 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
  - setRevision
```
public void setRevision(Integer revision)
```
  - minutesToComplete
```
public AssessmentReference2 minutesToComplete(Integer minutesToComplete)
```
  - getMinutesToComplete
```
public Integer getMinutesToComplete()
```
    The number of minutes it takes for a participant to complete this assessment.
    
    Returns:
    
    minutesToComplete
  - setMinutesToComplete
```
public void setMinutesToComplete(Integer minutesToComplete)
```
  - labels
```
public AssessmentReference2 labels(List<Label> labels)
```
  - addLabelsItem
```
public AssessmentReference2 addLabelsItem(Label labelsItem)
```
  - getLabels
```
public List<Label> getLabels()
```
    A collection of labels for this assessment. Only one label can be included for a given language. The system will first try and select the participant’s preferred languages (from most to least preferred), then it will select an English (“en”) language default label. If an English label does not exist in the list of labels, then the assessment’s title will be used as a label.
    
    Returns:
    
    labels
  - setLabels
```
public void setLabels(List<Label> labels)
```
  - colorScheme
```
public AssessmentReference2 colorScheme(ColorScheme colorScheme)
```
  - getColorScheme
```
public ColorScheme getColorScheme()
```
    Get colorScheme
    
    Returns:
    
    colorScheme
  - setColorScheme
```
public void setColorScheme(ColorScheme colorScheme)
```
  - imageResource
```
public AssessmentReference2 imageResource(ImageResource imageResource)
```
  - getImageResource
```
public ImageResource getImageResource()
```
    Get imageResource
    
    Returns:
    
    imageResource
  - setImageResource
```
public void setImageResource(ImageResource imageResource)
```
  - getType
```
public String getType()
```
    AssessmentReference
    
    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

Class AssessmentReference2

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AssessmentReference2

Method Detail

appId

getAppId

setAppId

guid

getGuid

setGuid

title

getTitle

setTitle

identifier

getIdentifier

setIdentifier

revision

getRevision

setRevision

minutesToComplete

getMinutesToComplete

setMinutesToComplete

labels

addLabelsItem

getLabels

setLabels

colorScheme

getColorScheme

setColorScheme

imageResource

getImageResource

setImageResource

getType

equals

hashCode

toString