org.sagebionetworks.bridge.rest.model

Class SharedModuleMetadata

java.lang.Object

org.sagebionetworks.bridge.rest.model.SharedModuleMetadata

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

Metadata for shared modules in the shared module library.

Constructor Summary

Constructors

Constructor and Description
SharedModuleMetadata()

Method Summary

Modifier and Type	Method and Description
SharedModuleMetadata	addTagsItem(String tagsItem)
SharedModuleMetadata	deleted(Boolean deleted)
boolean	equals(Object o)
String	getId() Unique ID of the module.
SharedModuleType	getModuleType() Get moduleType
String	getName() User-friendly module name.
String	getNotes() User-friendly descriptive notes for the module.
String	getOs() Which OS (iOS, Android, etc) this module applies to, if the module is OS-specific.
String	getSchemaId() Schema ID, if this module is a schema.
Integer	getSchemaRevision() Schema revision, if this module is a schema.
String	getSurveyCreatedOn() Survey created-on timestamp (as an ISO8601 timestamp), if this module is a survey.
String	getSurveyGuid() Survey GUID, if this module is a survey.
List<String>	getTags() An unordered list of tags, used for querying and filtering.
String	getType() SharedModuleMetadata
Integer	getVersion() Module version.
int	hashCode()
SharedModuleMetadata	id(String id)
Boolean	isDeleted() Has this shared module metadata been logically deleted (an admin can restore it)?
Boolean	isLicenseRestricted() True if usage of this module is restricted by license or copyright.
Boolean	isPublished() Flag that marks the module as published.
SharedModuleMetadata	licenseRestricted(Boolean licenseRestricted)
SharedModuleMetadata	name(String name)
SharedModuleMetadata	notes(String notes)
SharedModuleMetadata	os(String os)
SharedModuleMetadata	published(Boolean published)
SharedModuleMetadata	schemaId(String schemaId)
SharedModuleMetadata	schemaRevision(Integer schemaRevision)
void	setDeleted(Boolean deleted)
void	setId(String id)
void	setLicenseRestricted(Boolean licenseRestricted)
void	setName(String name)
void	setNotes(String notes)
void	setOs(String os)
void	setPublished(Boolean published)
void	setSchemaId(String schemaId)
void	setSchemaRevision(Integer schemaRevision)
void	setSurveyCreatedOn(String surveyCreatedOn)
void	setSurveyGuid(String surveyGuid)
void	setTags(List<String> tags)
void	setVersion(Integer version)
SharedModuleMetadata	surveyCreatedOn(String surveyCreatedOn)
SharedModuleMetadata	surveyGuid(String surveyGuid)
SharedModuleMetadata	tags(List<String> tags)
String	toString()
SharedModuleMetadata	version(Integer version)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SharedModuleMetadata

public SharedModuleMetadata()

Method Detail

id

public SharedModuleMetadata id(String id)

getId

public String getId()

Unique ID of the module.

Returns:

id

setId

public void setId(String id)

licenseRestricted

public SharedModuleMetadata licenseRestricted(Boolean licenseRestricted)

isLicenseRestricted

public Boolean isLicenseRestricted()

True if usage of this module is restricted by license or copyright.

Returns:

licenseRestricted

setLicenseRestricted

public void setLicenseRestricted(Boolean licenseRestricted)

getModuleType

public SharedModuleType getModuleType()

Get moduleType

Returns:

moduleType

name

public SharedModuleMetadata name(String name)

getName

public String getName()

User-friendly module name.

Returns:

name

setName

public void setName(String name)

notes

public SharedModuleMetadata notes(String notes)

getNotes

public String getNotes()

User-friendly descriptive notes for the module.

Returns:

notes

setNotes

public void setNotes(String notes)

os

public SharedModuleMetadata os(String os)

getOs

public String getOs()

Which OS (iOS, Android, etc) this module applies to, if the module is OS-specific.

Returns:

os

setOs

public void setOs(String os)

published

public SharedModuleMetadata published(Boolean published)

isPublished

public Boolean isPublished()

Flag that marks the module as published. A published module versions cannot be modified. However, another version of the same module can be created for continued editing.

Returns:

published

setPublished

public void setPublished(Boolean published)

schemaId

public SharedModuleMetadata schemaId(String schemaId)

getSchemaId

public String getSchemaId()

Schema ID, if this module is a schema.

Returns:

schemaId

setSchemaId

public void setSchemaId(String schemaId)

schemaRevision

public SharedModuleMetadata schemaRevision(Integer schemaRevision)

getSchemaRevision

public Integer getSchemaRevision()

Schema revision, if this module is a schema.

Returns:

schemaRevision

setSchemaRevision

public void setSchemaRevision(Integer schemaRevision)

surveyCreatedOn

public SharedModuleMetadata surveyCreatedOn(String surveyCreatedOn)

getSurveyCreatedOn

public String getSurveyCreatedOn()

Survey created-on timestamp (as an ISO8601 timestamp), if this module is a survey.

Returns:

surveyCreatedOn

setSurveyCreatedOn

public void setSurveyCreatedOn(String surveyCreatedOn)

surveyGuid

public SharedModuleMetadata surveyGuid(String surveyGuid)

getSurveyGuid

public String getSurveyGuid()

Survey GUID, if this module is a survey.

Returns:

surveyGuid

setSurveyGuid

public void setSurveyGuid(String surveyGuid)

tags

public SharedModuleMetadata tags(List<String> tags)

addTagsItem

public SharedModuleMetadata addTagsItem(String tagsItem)

getTags

public List<String> getTags()

An unordered list of tags, used for querying and filtering.

Returns:

tags

setTags

public void setTags(List<String> tags)

deleted

public SharedModuleMetadata deleted(Boolean deleted)

isDeleted

public Boolean isDeleted()

Has this shared module metadata been logically deleted (an admin can restore it)?

Returns:

deleted

setDeleted

public void setDeleted(Boolean deleted)

version

public SharedModuleMetadata version(Integer version)

getVersion

public Integer getVersion()

Module version.

Returns:

version

setVersion

public void setVersion(Integer version)

getType

public String getType()

SharedModuleMetadata

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