org.sagebionetworks.bridge.rest.model

Class AppConfig

java.lang.Object

org.sagebionetworks.bridge.rest.model.AppConfig

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2024-01-08T21:27:32.920Z")
public class AppConfig
extends Object

An app configuration object.

Constructor Summary

Constructors

Constructor and Description
AppConfig()

Method Summary

Modifier and Type	Method and Description
AppConfig	addAssessmentReferencesItem(AssessmentReference assessmentReferencesItem)
AppConfig	addConfigReferencesItem(ConfigReference configReferencesItem)
AppConfig	addFileReferencesItem(FileReference fileReferencesItem)
AppConfig	addSchemaReferencesItem(SchemaReference schemaReferencesItem)
AppConfig	addSurveyReferencesItem(SurveyReference surveyReferencesItem)
AppConfig	assessmentReferences(List<AssessmentReference> assessmentReferences)
AppConfig	clientData(Object clientData)
AppConfig	configElements(Map<String,Object> configElements)
AppConfig	configReferences(List<ConfigReference> configReferences)
AppConfig	criteria(Criteria criteria)
AppConfig	deleted(Boolean deleted)
boolean	equals(Object o)
AppConfig	fileReferences(List<FileReference> fileReferences)
List<AssessmentReference>	getAssessmentReferences() Get assessmentReferences
Object	getClientData() An arbitrary object that will be serialized and stored as JSON using the GSON serialization mechanisms.
Map<String,Object>	getConfigElements() A map of app config element IDs to the app config element JSON of a specific app config element revision (the revision given in the configReferences map).
List<ConfigReference>	getConfigReferences() Get configReferences
DateTime	getCreatedOn() The date and time the app config was created.
Criteria	getCriteria() Optional selection criteria that can be used to determine if an app should receive this configuration record or not.
List<FileReference>	getFileReferences() Get fileReferences
String	getGuid() Get guid
String	getLabel() Get label
DateTime	getModifiedOn() The date and time the app config was last modified.
List<SchemaReference>	getSchemaReferences() Get schemaReferences
List<SurveyReference>	getSurveyReferences() Get surveyReferences
String	getType() AppConfig
Long	getVersion() The optimistic locking version of the app config.
AppConfig	guid(String guid)
int	hashCode()
Boolean	isDeleted() Has this app config been logically deleted (an admin can restore it)?
AppConfig	label(String label)
AppConfig	putConfigElementsItem(String key, Object configElementsItem)
AppConfig	schemaReferences(List<SchemaReference> schemaReferences)
void	setAssessmentReferences(List<AssessmentReference> assessmentReferences)
void	setClientData(Object clientData)
void	setConfigElements(Map<String,Object> configElements)
void	setConfigReferences(List<ConfigReference> configReferences)
void	setCriteria(Criteria criteria)
void	setDeleted(Boolean deleted)
void	setFileReferences(List<FileReference> fileReferences)
void	setGuid(String guid)
void	setLabel(String label)
void	setSchemaReferences(List<SchemaReference> schemaReferences)
void	setSurveyReferences(List<SurveyReference> surveyReferences)
void	setVersion(Long version)
AppConfig	surveyReferences(List<SurveyReference> surveyReferences)
String	toString()
AppConfig	version(Long version)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AppConfig

public AppConfig()

Method Detail

label

public AppConfig label(String label)

getLabel

public String getLabel()

Get label

Returns:

label

setLabel

public void setLabel(String label)

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

guid

public AppConfig guid(String guid)

getGuid

public String getGuid()

Get guid

Returns:

guid

setGuid

public void setGuid(String guid)

deleted

public AppConfig deleted(Boolean deleted)

isDeleted

public Boolean isDeleted()

Has this app config been logically deleted (an admin can restore it)?

Returns:

deleted

setDeleted

public void setDeleted(Boolean deleted)

criteria

public AppConfig criteria(Criteria criteria)

getCriteria

public Criteria getCriteria()

Optional selection criteria that can be used to determine if an app should receive this configuration record or not. It is an error for a request to match more or less than one app config record.

Returns:

criteria

setCriteria

public void setCriteria(Criteria criteria)

clientData

public AppConfig clientData(Object clientData)

getClientData

public Object getClientData()

An arbitrary object that will be serialized and stored as JSON using the GSON serialization mechanisms. In Java this field is an Object; since the type of the object is not known, the rest-client includes a utility method: ``` MyCustomObject data = RestUtils.toType( activity.getClientData(), MyCustomObject.class); ```

Returns:

clientData

setClientData

public void setClientData(Object clientData)

surveyReferences

public AppConfig surveyReferences(List<SurveyReference> surveyReferences)

addSurveyReferencesItem

public AppConfig addSurveyReferencesItem(SurveyReference surveyReferencesItem)

getSurveyReferences

public List<SurveyReference> getSurveyReferences()

Get surveyReferences

Returns:

surveyReferences

setSurveyReferences

public void setSurveyReferences(List<SurveyReference> surveyReferences)

schemaReferences

public AppConfig schemaReferences(List<SchemaReference> schemaReferences)

addSchemaReferencesItem

public AppConfig addSchemaReferencesItem(SchemaReference schemaReferencesItem)

getSchemaReferences

public List<SchemaReference> getSchemaReferences()

Get schemaReferences

Returns:

schemaReferences

setSchemaReferences

public void setSchemaReferences(List<SchemaReference> schemaReferences)

configReferences

public AppConfig configReferences(List<ConfigReference> configReferences)

addConfigReferencesItem

public AppConfig addConfigReferencesItem(ConfigReference configReferencesItem)

getConfigReferences

public List<ConfigReference> getConfigReferences()

Get configReferences

Returns:

configReferences

setConfigReferences

public void setConfigReferences(List<ConfigReference> configReferences)

fileReferences

public AppConfig fileReferences(List<FileReference> fileReferences)

addFileReferencesItem

public AppConfig addFileReferencesItem(FileReference fileReferencesItem)

getFileReferences

public List<FileReference> getFileReferences()

Get fileReferences

Returns:

fileReferences

setFileReferences

public void setFileReferences(List<FileReference> fileReferences)

assessmentReferences

public AppConfig assessmentReferences(List<AssessmentReference> assessmentReferences)

addAssessmentReferencesItem

public AppConfig addAssessmentReferencesItem(AssessmentReference assessmentReferencesItem)

getAssessmentReferences

public List<AssessmentReference> getAssessmentReferences()

Get assessmentReferences

Returns:

assessmentReferences

setAssessmentReferences

public void setAssessmentReferences(List<AssessmentReference> assessmentReferences)

configElements

public AppConfig configElements(Map<String,Object> configElements)

putConfigElementsItem

public AppConfig putConfigElementsItem(String key,
                                       Object configElementsItem)

getConfigElements

public Map<String,Object> getConfigElements()

A map of app config element IDs to the app config element JSON of a specific app config element revision (the revision given in the configReferences map).

Returns:

configElements

setConfigElements

public void setConfigElements(Map<String,Object> configElements)

version

public AppConfig version(Long version)

getVersion

public Long getVersion()

The optimistic locking version of the app config. 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 `AppConfig` needs to be updated.

Returns:

version

setVersion

public void setVersion(Long version)

getType

public String getType()

AppConfig

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