org.sagebionetworks.bridge.rest.model

Class ReportData

java.lang.Object

org.sagebionetworks.bridge.rest.model.ReportData

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

The JSON data for one time point of a report (either a local date in the format YYYY-MM-DD, or an ISO 8601 timestamp; report records should all use one or the other format consistently). The `date` property can be used to submit either a local date or timestamp, and the value will be returned in the `date` property as well as the `localDate` or `dateTime` property depending on the format. You can also alternative submit `localDate` or `dateTime` (but never both), and you'll get back the value in that property as well as the `date` property. Data can be for a study as a whole, or a report on a single participant, depending on the endpoint that is used to persist the data in Bridge.

Constructor Summary

Constructors

Constructor and Description
ReportData()

Method Summary

Modifier and Type	Method and Description
ReportData	addStudyIdsItem(String studyIdsItem)
ReportData	data(Object data)
ReportData	date(String date)
ReportData	dateTime(DateTime dateTime)
boolean	equals(Object o)
Object	getData() An arbitrary JSON object containing whatever data should be saved for a report.
String	getDate() The date (whether local or an ISO timestamp) of the report data.
DateTime	getDateTime() The date expressed as an ISO 8601 timestamp.
LocalDate	getLocalDate() The date expressed as a LocalDate (YYYY-MM-DD)
List<String>	getStudyIds() The studies this report record is associated to (these are set with the first record that is submitted and that creates a report index, and cannot be changed afterward unless the user is a study-wide user not associated to any specific study.
String	getType() ReportData
int	hashCode()
ReportData	localDate(LocalDate localDate)
void	setData(Object data)
void	setDate(String date)
void	setDateTime(DateTime dateTime)
void	setLocalDate(LocalDate localDate)
void	setStudyIds(List<String> studyIds)
ReportData	studyIds(List<String> studyIds)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ReportData

public ReportData()

Method Detail

date

public ReportData date(String date)

getDate

public String getDate()

The date (whether local or an ISO timestamp) of the report data.

Returns:

date

setDate

public void setDate(String date)

localDate

public ReportData localDate(LocalDate localDate)

getLocalDate

public LocalDate getLocalDate()

The date expressed as a LocalDate (YYYY-MM-DD)

Returns:

localDate

setLocalDate

public void setLocalDate(LocalDate localDate)

dateTime

public ReportData dateTime(DateTime dateTime)

getDateTime

public DateTime getDateTime()

The date expressed as an ISO 8601 timestamp.

Returns:

dateTime

setDateTime

public void setDateTime(DateTime dateTime)

data

public ReportData data(Object data)

getData

public Object getData()

An arbitrary JSON object containing whatever data should be saved for a report.

Returns:

data

setData

public void setData(Object data)

studyIds

public ReportData studyIds(List<String> studyIds)

addStudyIdsItem

public ReportData addStudyIdsItem(String studyIdsItem)

getStudyIds

public List<String> getStudyIds()

The studies this report record is associated to (these are set with the first record that is submitted and that creates a report index, and cannot be changed afterward unless the user is a study-wide user not associated to any specific study.

Returns:

studyIds

setStudyIds

public void setStudyIds(List<String> studyIds)

getType

public String getType()

ReportData

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