ExternalResource (REST Client 0.25.15 API)

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

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

An external identifier assigned to a participant's account to allow external re-identification of the user by the study sponsor.

Constructor Summary

Constructors
Constructor and Description

ExternalResource()

Constructors
Constructor and Description
`ExternalResource()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ExternalResource`	`addContributorsItem(String contributorsItem)`
`ExternalResource`	`addCreatorsItem(String creatorsItem)`
`ExternalResource`	`addPublishersItem(String publishersItem)`
`ExternalResource`	`category(ResourceCategory category)`
`ExternalResource`	`contributors(List<String> contributors)`
`ExternalResource`	`createdAtRevision(Integer createdAtRevision)`
`ExternalResource`	`creators(List<String> creators)`
`ExternalResource`	`date(String date)`
`ExternalResource`	`deleted(Boolean deleted)`
`ExternalResource`	`description(String description)`
`boolean`	`equals(Object o)`
`ExternalResource`	`format(String format)`
`ResourceCategory`	`getCategory()` One of an enumerated list of categories of documentation resources.
`List<String>`	`getContributors()` Non-authorial contributors to the documentation (researchers who participated in the research, grant funders, or the like).
`Integer`	`getCreatedAtRevision()` The revision of the assessment at the time this resource was created or updated.
`DateTime`	`getCreatedOn()` The date and time the app config was created.
`List<String>`	`getCreators()` The authors of the documentation.
`String`	`getDate()` The date of publication of the resource (a human-readable format is sufficient unless you wish to sort by this field).
`String`	`getDescription()` Short description of the resource this link is documenting.
`String`	`getFormat()` The format of the resource being described, expressed as a MIME type (e.g.
`String`	`getGuid()` Get guid
`String`	`getLanguage()` The language of the resource being described by this link. It is probably not necessary to use something structured like ISO 639-1 language codes, the name of the language in English will do.
`Integer`	`getMaxRevision()` The least (highest) revision of an assessment that this resource applies to.
`Integer`	`getMinRevision()` The earlist (lowest) revision of an assessment that this resource applies to.
`DateTime`	`getModifiedOn()` The date and time the app config was last modified.
`List<String>`	`getPublishers()` A list of the publishers (or institutions, or even hosting sites) supporting publication of the documentation.
`String`	`getTitle()` Get title
`String`	`getType()` ExternalResource
`String`	`getUrl()` The link to retrieve the resource via the Internet.
`Long`	`getVersion()` The optimistic locking version of the assessment.
`ExternalResource`	`guid(String guid)`
`int`	`hashCode()`
`Boolean`	`isDeleted()` Has this external resource been logically deleted (an admin can restore it)?
`Boolean`	`isUpToDate()` The `createdAtRevision` field records the revision of the assessment when this resource link was created or last updated.
`ExternalResource`	`language(String language)`
`ExternalResource`	`maxRevision(Integer maxRevision)`
`ExternalResource`	`minRevision(Integer minRevision)`
`ExternalResource`	`publishers(List<String> publishers)`
`void`	`setCategory(ResourceCategory category)`
`void`	`setContributors(List<String> contributors)`
`void`	`setCreatedAtRevision(Integer createdAtRevision)`
`void`	`setCreators(List<String> creators)`
`void`	`setDate(String date)`
`void`	`setDeleted(Boolean deleted)`
`void`	`setDescription(String description)`
`void`	`setFormat(String format)`
`void`	`setGuid(String guid)`
`void`	`setLanguage(String language)`
`void`	`setMaxRevision(Integer maxRevision)`
`void`	`setMinRevision(Integer minRevision)`
`void`	`setPublishers(List<String> publishers)`
`void`	`setTitle(String title)`
`void`	`setUrl(String url)`
`void`	`setVersion(Long version)`
`ExternalResource`	`title(String title)`
`String`	`toString()`
`ExternalResource`	`url(String url)`
`ExternalResource`	`version(Long version)`

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

- Constructor Detail
  - ExternalResource
```
public ExternalResource()
```
- Method Detail
  - guid
```
public ExternalResource guid(String guid)
```
  - getGuid
```
public String getGuid()
```
    Get guid
    
    Returns:
    
    guid
  - setGuid
```
public void setGuid(String guid)
```
  - title
```
public ExternalResource title(String title)
```
  - getTitle
```
public String getTitle()
```
    Get title
    
    Returns:
    
    title
  - setTitle
```
public void setTitle(String title)
```
  - category
```
public ExternalResource category(ResourceCategory category)
```
  - getCategory
```
public ResourceCategory getCategory()
```
    One of an enumerated list of categories of documentation resources.
    
    Returns:
    
    category
  - setCategory
```
public void setCategory(ResourceCategory category)
```
  - url
```
public ExternalResource url(String url)
```
  - getUrl
```
public String getUrl()
```
    The link to retrieve the resource via the Internet.
    
    Returns:
    
    url
  - setUrl
```
public void setUrl(String url)
```
  - format
```
public ExternalResource format(String format)
```
  - getFormat
```
public String getFormat()
```
    The format of the resource being described, expressed as a MIME type (e.g. \"text/html\" or \"application/pdf\").
    
    Returns:
    
    format
  - setFormat
```
public void setFormat(String format)
```
  - date
```
public ExternalResource date(String date)
```
  - getDate
```
public String getDate()
```
    The date of publication of the resource (a human-readable format is sufficient unless you wish to sort by this field).
    
    Returns:
    
    date
  - setDate
```
public void setDate(String date)
```
  - description
```
public ExternalResource description(String description)
```
  - getDescription
```
public String getDescription()
```
    Short description of the resource this link is documenting.
    
    Returns:
    
    description
  - setDescription
```
public void setDescription(String description)
```
  - contributors
```
public ExternalResource contributors(List<String> contributors)
```
  - addContributorsItem
```
public ExternalResource addContributorsItem(String contributorsItem)
```
  - getContributors
```
public List<String> getContributors()
```
    Non-authorial contributors to the documentation (researchers who participated in the research, grant funders, or the like).
    
    Returns:
    
    contributors
  - setContributors
```
public void setContributors(List<String> contributors)
```
  - creators
```
public ExternalResource creators(List<String> creators)
```
  - addCreatorsItem
```
public ExternalResource addCreatorsItem(String creatorsItem)
```
  - getCreators
```
public List<String> getCreators()
```
    The authors of the documentation.
    
    Returns:
    
    creators
  - setCreators
```
public void setCreators(List<String> creators)
```
  - publishers
```
public ExternalResource publishers(List<String> publishers)
```
  - addPublishersItem
```
public ExternalResource addPublishersItem(String publishersItem)
```
  - getPublishers
```
public List<String> getPublishers()
```
    A list of the publishers (or institutions, or even hosting sites) supporting publication of the documentation.
    
    Returns:
    
    publishers
  - setPublishers
```
public void setPublishers(List<String> publishers)
```
  - language
```
public ExternalResource language(String language)
```
  - getLanguage
```
public String getLanguage()
```
    The language *of the resource being described by this link.* It is probably not necessary to use something structured like ISO 639-1 language codes, the name of the language in English will do.
    
    Returns:
    
    language
  - setLanguage
```
public void setLanguage(String language)
```
  - minRevision
```
public ExternalResource minRevision(Integer minRevision)
```
  - getMinRevision
```
public Integer getMinRevision()
```
    The earlist (lowest) revision of an assessment that this resource applies to. This value indicates that a resource was added to describe a development in the evolution of the assessment, or some other change to the assessment. For release notes about one specific revision of the assessment, minRevision can equal maxRevision.
    
    Returns:
    
    minRevision
  - setMinRevision
```
public void setMinRevision(Integer minRevision)
```
  - maxRevision
```
public ExternalResource maxRevision(Integer maxRevision)
```
  - getMaxRevision
```
public Integer getMaxRevision()
```
    The least (highest) revision of an assessment that this resource applies to. This deprecates the associated resource while keeping the link for reference. For release notes about one specific revision of the assessment, minRevision can equal maxRevision.
    
    Returns:
    
    maxRevision
  - setMaxRevision
```
public void setMaxRevision(Integer maxRevision)
```
  - createdAtRevision
```
public ExternalResource createdAtRevision(Integer createdAtRevision)
```
  - getCreatedAtRevision
```
public Integer getCreatedAtRevision()
```
    The revision of the assessment at the time this resource was created or updated. Used to determine if the resource may be out-of-date.
    
    Returns:
    
    createdAtRevision
  - setCreatedAtRevision
```
public void setCreatedAtRevision(Integer createdAtRevision)
```
  - getCreatedOn
```
public DateTime getCreatedOn()
```
    The date and time the app config was created.
    
    Returns:
    
    createdOn
  - getModifiedOn
```
public DateTime getModifiedOn()
```
    The date and time the app config was last modified.
    
    Returns:
    
    modifiedOn
  - deleted
```
public ExternalResource deleted(Boolean deleted)
```
  - isDeleted
```
public Boolean isDeleted()
```
    Has this external resource been logically deleted (an admin can restore it)?
    
    Returns:
    
    deleted
  - setDeleted
```
public void setDeleted(Boolean deleted)
```
  - version
```
public ExternalResource 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)
```
  - isUpToDate
```
public Boolean isUpToDate()
```
    The `createdAtRevision` field records the revision of the assessment when this resource link was created or last updated. If that value is equal to the most recent (highest) revision of the assessment, `upToDate` will be true. Otherwise it will be false. This can help flag resources that may no longer be relevant for the assessment.
    
    Returns:
    
    upToDate
  - getType
```
public String getType()
```
    ExternalResource
    
    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 ExternalResource

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ExternalResource

Method Detail

guid

getGuid

setGuid

title

getTitle

setTitle

category

getCategory

setCategory

url

getUrl

setUrl

format

getFormat

setFormat

date

getDate

setDate

description

getDescription

setDescription

contributors

addContributorsItem

getContributors

setContributors

creators

addCreatorsItem

getCreators

setCreators

publishers

addPublishersItem

getPublishers

setPublishers

language

getLanguage

setLanguage

minRevision

getMinRevision

setMinRevision

maxRevision

getMaxRevision

setMaxRevision

createdAtRevision

getCreatedAtRevision

setCreatedAtRevision

getCreatedOn

getModifiedOn

deleted

isDeleted

setDeleted

version

getVersion

setVersion

isUpToDate

getType

equals

hashCode

toString