Assessment (REST Client 0.25.28 API)

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

```
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2023-07-13T01:30:51.265Z")
public class Assessment
extends Object
```
The assessment object contains the general cataloguing information we have on an assessment, and includes both a set of links to documents that describe the assessment and its use, as well as a configuration object for client applications. An assessment can be defined in an app context, or it can be shared in our shared assessment libary. Assessments are globally visible to all study authors in an app context, but are owned by a specific organization, and only members of that organization can edit the assessment. When shared, the configuration for an assessment is immutable and there are no APIs to update it.

Constructor Summary

Constructors
Constructor and Description

Assessment()

Constructors
Constructor and Description
`Assessment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Assessment`	`additionalMetadata(Object additionalMetadata)`
`Assessment`	`addLabelsItem(Label labelsItem)`
`Assessment`	`addTagsItem(String tagsItem)`
`Assessment`	`category(String category)`
`Assessment`	`colorScheme(ColorScheme colorScheme)`
`Assessment`	`customizationFields(Map<String,List<PropertyInfo>> customizationFields)`
`Assessment`	`deleted(Boolean deleted)`
`boolean`	`equals(Object o)`
`Assessment`	`frameworkIdentifier(String frameworkIdentifier)`
`Object`	`getAdditionalMetadata()` Additional metadata fields, expressed as a key-value map.
`String`	`getCategory()` The category of assessment.
`ColorScheme`	`getColorScheme()` Get colorScheme
`DateTime`	`getCreatedOn()` The date and time the assessment was created.
`Map<String,List<PropertyInfo>>`	`getCustomizationFields()` A map of AssessmentNode GUIDs to a set of field identifiers in that node that can be customized by developers without invalidating an assessment (the assessment will maintain its link to the shared assessment it was derived from, if any, and the authors of the assessment are confident that these changes to the configuration will not invalidate the scientific validity of the assessment).
`String`	`getFrameworkIdentifier()` The framework this assessment belongs to.
`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`	`getJsonSchemaUrl()` A URL for a resource specifying a JSON schema for the archived results.
`List<Label>`	`getLabels()` A collection of labels for this assessment.
`Integer`	`getMaxAge()` The maximum age for which this assessment has been validated.
`Integer`	`getMinAge()` The minimum age for which this assessment has been validated.
`Integer`	`getMinutesToComplete()` The number of minutes it takes for a participant to complete this assessment.
`DateTime`	`getModifiedOn()` The date and time the assessment was last modified.
`String`	`getNormingStatus()` Get normingStatus
`String`	`getOriginGuid()` If this assessment was copied from a shared assessment, this will be the GUID of the shared assessment revision that was used to make this copy.
`String`	`getOsName()` The name of the operating system (conventional names are \"Android,\" \"iPhone OS,\" and \"Both\").
`String`	`getOwnerId()` The ID of the organization that owns this assessment.
`Long`	`getRevision()` Get revision
`String`	`getSummary()` Get summary
`List<String>`	`getTags()` A set of tags that apply to this assessment.
`String`	`getTitle()` A name for the assessment that is shown to study designers, but not to study participants if there are labels that can be shown instead.
`String`	`getType()` Assessment
`String`	`getValidationStatus()` Get validationStatus
`Long`	`getVersion()` The optimistic locking version of the assessment.
`Assessment`	`guid(String guid)`
`int`	`hashCode()`
`Assessment`	`identifier(String identifier)`
`Assessment`	`imageResource(ImageResource imageResource)`
`Boolean`	`isDeleted()` Has this assessment been logically deleted (an admin can restore it)?
`Assessment`	`jsonSchemaUrl(String jsonSchemaUrl)`
`Assessment`	`labels(List<Label> labels)`
`Assessment`	`maxAge(Integer maxAge)`
`Assessment`	`minAge(Integer minAge)`
`Assessment`	`minutesToComplete(Integer minutesToComplete)`
`Assessment`	`normingStatus(String normingStatus)`
`Assessment`	`originGuid(String originGuid)`
`Assessment`	`osName(String osName)`
`Assessment`	`ownerId(String ownerId)`
`Assessment`	`putCustomizationFieldsItem(String key, List<PropertyInfo> customizationFieldsItem)`
`Assessment`	`revision(Long revision)`
`void`	`setAdditionalMetadata(Object additionalMetadata)`
`void`	`setCategory(String category)`
`void`	`setColorScheme(ColorScheme colorScheme)`
`void`	`setCustomizationFields(Map<String,List<PropertyInfo>> customizationFields)`
`void`	`setDeleted(Boolean deleted)`
`void`	`setFrameworkIdentifier(String frameworkIdentifier)`
`void`	`setGuid(String guid)`
`void`	`setIdentifier(String identifier)`
`void`	`setImageResource(ImageResource imageResource)`
`void`	`setJsonSchemaUrl(String jsonSchemaUrl)`
`void`	`setLabels(List<Label> labels)`
`void`	`setMaxAge(Integer maxAge)`
`void`	`setMinAge(Integer minAge)`
`void`	`setMinutesToComplete(Integer minutesToComplete)`
`void`	`setNormingStatus(String normingStatus)`
`void`	`setOriginGuid(String originGuid)`
`void`	`setOsName(String osName)`
`void`	`setOwnerId(String ownerId)`
`void`	`setRevision(Long revision)`
`void`	`setSummary(String summary)`
`void`	`setTags(List<String> tags)`
`void`	`setTitle(String title)`
`void`	`setValidationStatus(String validationStatus)`
`void`	`setVersion(Long version)`
`Assessment`	`summary(String summary)`
`Assessment`	`tags(List<String> tags)`
`Assessment`	`title(String title)`
`String`	`toString()`
`Assessment`	`validationStatus(String validationStatus)`
`Assessment`	`version(Long version)`

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

- Constructor Detail
  - Assessment
```
public Assessment()
```
- Method Detail
  - guid
```
public Assessment guid(String guid)
```
  - 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
  - setGuid
```
public void setGuid(String guid)
```
  - identifier
```
public Assessment identifier(String identifier)
```
  - getIdentifier
```
public String getIdentifier()
```
    A human-readable identifier for an assessment, which can have one or more revisions.
    
    Returns:
    
    identifier
  - setIdentifier
```
public void setIdentifier(String identifier)
```
  - revision
```
public Assessment revision(Long revision)
```
  - getRevision
```
public Long getRevision()
```
    Get revision
    
    Returns:
    
    revision
  - setRevision
```
public void setRevision(Long revision)
```
  - ownerId
```
public Assessment ownerId(String ownerId)
```
  - getOwnerId
```
public String getOwnerId()
```
    The ID of the organization that owns this assessment. Only members of that organization will be able to edit the assessment, either in an app context or in the shared assessment library.
    
    Returns:
    
    ownerId
  - setOwnerId
```
public void setOwnerId(String ownerId)
```
  - title
```
public Assessment title(String title)
```
  - getTitle
```
public String getTitle()
```
    A name for the assessment that is shown to study designers, but not to study participants if there are labels that can be shown instead.
    
    Returns:
    
    title
  - setTitle
```
public void setTitle(String title)
```
  - labels
```
public Assessment labels(List<Label> labels)
```
  - addLabelsItem
```
public Assessment addLabelsItem(Label labelsItem)
```
  - getLabels
```
public List<Label> getLabels()
```
    A collection of labels for this assessment. Only one label can be included for each language, and if the user’s language cannot be selected, English will be selected as a default. If an English label does not exist, then the assessment title can be used instead.
    
    Returns:
    
    labels
  - setLabels
```
public void setLabels(List<Label> labels)
```
  - colorScheme
```
public Assessment colorScheme(ColorScheme colorScheme)
```
  - getColorScheme
```
public ColorScheme getColorScheme()
```
    Get colorScheme
    
    Returns:
    
    colorScheme
  - setColorScheme
```
public void setColorScheme(ColorScheme colorScheme)
```
  - summary
```
public Assessment summary(String summary)
```
  - getSummary
```
public String getSummary()
```
    Get summary
    
    Returns:
    
    summary
  - setSummary
```
public void setSummary(String summary)
```
  - osName
```
public Assessment osName(String osName)
```
  - getOsName
```
public String getOsName()
```
    The name of the operating system (conventional names are \"Android,\" \"iPhone OS,\" and \"Both\").
    
    Returns:
    
    osName
  - setOsName
```
public void setOsName(String osName)
```
  - originGuid
```
public Assessment originGuid(String originGuid)
```
  - getOriginGuid
```
public String getOriginGuid()
```
    If this assessment was copied from a shared assessment, this will be the GUID of the shared assessment revision that was used to make this copy. Certain aspects of the assessment (notably, the assessment's configuration) are guaranteed to be identical to this origin assessment.
    
    Returns:
    
    originGuid
  - setOriginGuid
```
public void setOriginGuid(String originGuid)
```
  - validationStatus
```
public Assessment validationStatus(String validationStatus)
```
  - getValidationStatus
```
public String getValidationStatus()
```
    Get validationStatus
    
    Returns:
    
    validationStatus
  - setValidationStatus
```
public void setValidationStatus(String validationStatus)
```
  - normingStatus
```
public Assessment normingStatus(String normingStatus)
```
  - getNormingStatus
```
public String getNormingStatus()
```
    Get normingStatus
    
    Returns:
    
    normingStatus
  - setNormingStatus
```
public void setNormingStatus(String normingStatus)
```
  - minutesToComplete
```
public Assessment 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)
```
  - tags
```
public Assessment tags(List<String> tags)
```
  - addTagsItem
```
public Assessment addTagsItem(String tagsItem)
```
  - getTags
```
public List<String> getTags()
```
    A set of tags that apply to this assessment. Tags should be namespaced with a prefix followed by a period (e.g. \"category.neurodegenerative\"), as the tag API will give you these tags in a map keyed from the prefix to a list of the values under that prefix.
    
    Returns:
    
    tags
  - setTags
```
public void setTags(List<String> tags)
```
  - customizationFields
```
public Assessment customizationFields(Map<String,List<PropertyInfo>> customizationFields)
```
  - putCustomizationFieldsItem
```
public Assessment putCustomizationFieldsItem(String key,
                                             List<PropertyInfo> customizationFieldsItem)
```
  - getCustomizationFields
```
public Map<String,List<PropertyInfo>> getCustomizationFields()
```
    A map of AssessmentNode GUIDs to a set of field identifiers in that node that can be customized by developers without invalidating an assessment (the assessment will maintain its link to the shared assessment it was derived from, if any, and the authors of the assessment are confident that these changes to the configuration will not invalidate the scientific validity of the assessment). This specification guides validation of submissions to update an AssessmentNode through a specific customization API.
    
    Returns:
    
    customizationFields
  - setCustomizationFields
```
public void setCustomizationFields(Map<String,List<PropertyInfo>> customizationFields)
```
  - getCreatedOn
```
public DateTime getCreatedOn()
```
    The date and time the assessment was created.
    
    Returns:
    
    createdOn
  - getModifiedOn
```
public DateTime getModifiedOn()
```
    The date and time the assessment was last modified.
    
    Returns:
    
    modifiedOn
  - deleted
```
public Assessment deleted(Boolean deleted)
```
  - isDeleted
```
public Boolean isDeleted()
```
    Has this assessment been logically deleted (an admin can restore it)?
    
    Returns:
    
    deleted
  - setDeleted
```
public void setDeleted(Boolean deleted)
```
  - version
```
public Assessment version(Long version)
```
  - getVersion
```
public Long getVersion()
```
    The optimistic locking version of the assessment. This value must be submitted as part of the next update of the model. If it does not match the value on the server, a 409 error (Conflict) will prevent the update from occurring. It can also serve as a key to determine if a local cache of `Assessment` needs to be updated.
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(Long version)
```
  - imageResource
```
public Assessment imageResource(ImageResource imageResource)
```
  - getImageResource
```
public ImageResource getImageResource()
```
    Get imageResource
    
    Returns:
    
    imageResource
  - setImageResource
```
public void setImageResource(ImageResource imageResource)
```
  - frameworkIdentifier
```
public Assessment frameworkIdentifier(String frameworkIdentifier)
```
  - getFrameworkIdentifier
```
public String getFrameworkIdentifier()
```
    The framework this assessment belongs to.
    
    Returns:
    
    frameworkIdentifier
  - setFrameworkIdentifier
```
public void setFrameworkIdentifier(String frameworkIdentifier)
```
  - jsonSchemaUrl
```
public Assessment jsonSchemaUrl(String jsonSchemaUrl)
```
  - getJsonSchemaUrl
```
public String getJsonSchemaUrl()
```
    A URL for a resource specifying a JSON schema for the archived results.
    
    Returns:
    
    jsonSchemaUrl
  - setJsonSchemaUrl
```
public void setJsonSchemaUrl(String jsonSchemaUrl)
```
  - category
```
public Assessment category(String category)
```
  - getCategory
```
public String getCategory()
```
    The category of assessment.
    
    Returns:
    
    category
  - setCategory
```
public void setCategory(String category)
```
  - minAge
```
public Assessment minAge(Integer minAge)
```
  - getMinAge
```
public Integer getMinAge()
```
    The minimum age for which this assessment has been validated.
    
    Returns:
    
    minAge
  - setMinAge
```
public void setMinAge(Integer minAge)
```
  - maxAge
```
public Assessment maxAge(Integer maxAge)
```
  - getMaxAge
```
public Integer getMaxAge()
```
    The maximum age for which this assessment has been validated.
    
    Returns:
    
    maxAge
  - setMaxAge
```
public void setMaxAge(Integer maxAge)
```
  - additionalMetadata
```
public Assessment additionalMetadata(Object additionalMetadata)
```
  - getAdditionalMetadata
```
public Object getAdditionalMetadata()
```
    Additional metadata fields, expressed as a key-value map.
    
    Returns:
    
    additionalMetadata
  - setAdditionalMetadata
```
public void setAdditionalMetadata(Object additionalMetadata)
```
  - getType
```
public String getType()
```
    Assessment
    
    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 Assessment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Assessment

Method Detail

guid

getGuid

setGuid

identifier

getIdentifier

setIdentifier

revision

getRevision

setRevision

ownerId

getOwnerId

setOwnerId

title

getTitle

setTitle

labels

addLabelsItem

getLabels

setLabels

colorScheme

getColorScheme

setColorScheme

summary

getSummary

setSummary

osName

getOsName

setOsName

originGuid

getOriginGuid

setOriginGuid

validationStatus

getValidationStatus

setValidationStatus

normingStatus

getNormingStatus

setNormingStatus

minutesToComplete

getMinutesToComplete

setMinutesToComplete

tags

addTagsItem

getTags

setTags

customizationFields

putCustomizationFieldsItem

getCustomizationFields

setCustomizationFields

getCreatedOn

getModifiedOn

deleted

isDeleted

setDeleted

version

getVersion

setVersion

imageResource

getImageResource

setImageResource

frameworkIdentifier

getFrameworkIdentifier

setFrameworkIdentifier

jsonSchemaUrl

getJsonSchemaUrl

setJsonSchemaUrl

category

getCategory

setCategory

minAge

getMinAge

setMinAge

maxAge

getMaxAge