Survey (REST Client 0.25.15 API)

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

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

The definition of a survey.

Constructor Summary

Constructors
Constructor and Description

Survey()

Constructors
Constructor and Description
`Survey()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Survey`	`addElementsItem(SurveyElement elementsItem)`
`Survey`	`copyrightNotice(String copyrightNotice)`
`Survey`	`createdOn(DateTime createdOn)`
`Survey`	`deleted(Boolean deleted)`
`Survey`	`elements(List<SurveyElement> elements)`
`boolean`	`equals(Object o)`
`String`	`getCopyrightNotice()` A copyright notice identifying the owners of the published work.
`DateTime`	`getCreatedOn()` The ISO 8601 date on which this version of this survey was created.
`List<SurveyElement>`	`getElements()` An ordered collection of SurveyElement sub-types (in the order they will appear in the survey).
`String`	`getGuid()` Get guid
`String`	`getIdentifier()` A private name for the survey, only visible to researchers, used to identify the survey on export.
`DateTime`	`getModifiedOn()` The date and time when this version of the survey was last modified.
`String`	`getModuleId()` Module ID, if this survey was imported from a shared module.
`Integer`	`getModuleVersion()` Module version, if this survey was imported from a shared module.
`String`	`getName()` The name of this survey.
`Long`	`getSchemaRevision()` The corresponding schema revision that Bridge server uses to export survey answers to Synapse.
`String`	`getType()` Survey
`Long`	`getVersion()` The version of this survey as used to implement optimistic locking.
`Survey`	`guid(String guid)`
`int`	`hashCode()`
`Survey`	`identifier(String identifier)`
`Boolean`	`isDeleted()` Has this survey been logically deleted (an admin can restore it)?
`Boolean`	`isPublished()` True if this survey revision has been published, and is accessible to users through scheduling.
`Survey`	`moduleId(String moduleId)`
`Survey`	`moduleVersion(Integer moduleVersion)`
`Survey`	`name(String name)`
`Survey`	`schemaRevision(Long schemaRevision)`
`void`	`setCopyrightNotice(String copyrightNotice)`
`void`	`setCreatedOn(DateTime createdOn)`
`void`	`setDeleted(Boolean deleted)`
`void`	`setElements(List<SurveyElement> elements)`
`void`	`setGuid(String guid)`
`void`	`setIdentifier(String identifier)`
`void`	`setModuleId(String moduleId)`
`void`	`setModuleVersion(Integer moduleVersion)`
`void`	`setName(String name)`
`void`	`setSchemaRevision(Long schemaRevision)`
`void`	`setVersion(Long version)`
`String`	`toString()`
`Survey`	`version(Long version)`

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

- Constructor Detail
  - Survey
```
public Survey()
```
- Method Detail
  - guid
```
public Survey guid(String guid)
```
  - getGuid
```
public String getGuid()
```
    Get guid
    
    Returns:
    
    guid
  - setGuid
```
public void setGuid(String guid)
```
  - moduleId
```
public Survey moduleId(String moduleId)
```
  - getModuleId
```
public String getModuleId()
```
    Module ID, if this survey was imported from a shared module.
    
    Returns:
    
    moduleId
  - setModuleId
```
public void setModuleId(String moduleId)
```
  - moduleVersion
```
public Survey moduleVersion(Integer moduleVersion)
```
  - getModuleVersion
```
public Integer getModuleVersion()
```
    Module version, if this survey was imported from a shared module.
    
    Returns:
    
    moduleVersion
  - setModuleVersion
```
public void setModuleVersion(Integer moduleVersion)
```
  - name
```
public Survey name(String name)
```
  - getName
```
public String getName()
```
    The name of this survey. The name can be changed after creation, and should not appear in the UI.
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
  - identifier
```
public Survey identifier(String identifier)
```
  - getIdentifier
```
public String getIdentifier()
```
    A private name for the survey, only visible to researchers, used to identify the survey on export. It is recommended (but not required) that this identifier be unique for this survey type within this app.
    
    Returns:
    
    identifier
  - setIdentifier
```
public void setIdentifier(String identifier)
```
  - isPublished
```
public Boolean isPublished()
```
    True if this survey revision has been published, and is accessible to users through scheduling. More than one version of a survey may be published; it is most common to return the most recently published version to users.
    
    Returns:
    
    published
  - schemaRevision
```
public Survey schemaRevision(Long schemaRevision)
```
  - getSchemaRevision
```
public Long getSchemaRevision()
```
    The corresponding schema revision that Bridge server uses to export survey answers to Synapse.
    
    Returns:
    
    schemaRevision
  - setSchemaRevision
```
public void setSchemaRevision(Long schemaRevision)
```
  - createdOn
```
public Survey createdOn(DateTime createdOn)
```
  - getCreatedOn
```
public DateTime getCreatedOn()
```
    The ISO 8601 date on which this version of this survey was created.
    
    Returns:
    
    createdOn
  - setCreatedOn
```
public void setCreatedOn(DateTime createdOn)
```
  - getModifiedOn
```
public DateTime getModifiedOn()
```
    The date and time when this version of the survey was last modified.
    
    Returns:
    
    modifiedOn
  - copyrightNotice
```
public Survey copyrightNotice(String copyrightNotice)
```
  - getCopyrightNotice
```
public String getCopyrightNotice()
```
    A copyright notice identifying the owners of the published work.
    
    Returns:
    
    copyrightNotice
  - setCopyrightNotice
```
public void setCopyrightNotice(String copyrightNotice)
```
  - deleted
```
public Survey deleted(Boolean deleted)
```
  - isDeleted
```
public Boolean isDeleted()
```
    Has this survey been logically deleted (an admin can restore it)?
    
    Returns:
    
    deleted
  - setDeleted
```
public void setDeleted(Boolean deleted)
```
  - version
```
public Survey version(Long version)
```
  - getVersion
```
public Long getVersion()
```
    The version of this survey as used to implement optimistic locking. This must be passed back to the server on an update, unmodified, in order for the update to succeed. If the survey has been concurrently modified, the update will throw an error.
    
    Returns:
    
    version
  - setVersion
```
public void setVersion(Long version)
```
  - elements
```
public Survey elements(List<SurveyElement> elements)
```
  - addElementsItem
```
public Survey addElementsItem(SurveyElement elementsItem)
```
  - getElements
```
public List<SurveyElement> getElements()
```
    An ordered collection of SurveyElement sub-types (in the order they will appear in the survey).
    
    Returns:
    
    elements
  - setElements
```
public void setElements(List<SurveyElement> elements)
```
  - getType
```
public String getType()
```
    Survey
    
    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 Survey

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Survey

Method Detail

guid

getGuid

setGuid

moduleId

getModuleId

setModuleId

moduleVersion

getModuleVersion

setModuleVersion

name

getName

setName

identifier

getIdentifier

setIdentifier

isPublished

schemaRevision

getSchemaRevision

setSchemaRevision

createdOn

getCreatedOn

setCreatedOn

getModifiedOn

copyrightNotice

getCopyrightNotice

setCopyrightNotice

deleted

isDeleted

setDeleted

version

getVersion

setVersion

elements

addElementsItem

getElements

setElements

getType

equals

hashCode

toString