org.sagebionetworks.bridge.rest.model

Class AdherenceReportSearch

java.lang.Object

org.sagebionetworks.bridge.rest.model.AdherenceReportSearch

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

AdherenceReportSearch

Constructor Summary

Constructors

Constructor and Description
AdherenceReportSearch()

Method Summary

Modifier and Type	Method and Description
AdherenceReportSearch	addLabelFiltersItem(String labelFiltersItem)
AdherenceReportSearch	addProgressionFiltersItem(ParticipantStudyProgress progressionFiltersItem)
AdherenceReportSearch	adherenceMax(Integer adherenceMax)
AdherenceReportSearch	adherenceMin(Integer adherenceMin)
boolean	equals(Object o)
Integer	getAdherenceMax() Only return records with a weekly adherence at or below this value.
Integer	getAdherenceMin() Only return records with a weekly adherence at or above this value.
String	getIdFilter() Only return records where one of the participant’s identifier fields (externalId, identifier, firstName, lastName, email, or phone number) includes the `idFilter` string.
List<String>	getLabelFilters() Return records where the labels of the entries includes one or more of the labels in this array.
Integer	getOffsetBy() Get offsetBy
Integer	getPageSize() Get pageSize
List<ParticipantStudyProgress>	getProgressionFilters() Filter records by whether the participant has finished, not yet begun, and/or is currently participating in the study.
TestFilter	getTestFilter() Return test, production, or both kinds of records.
String	getType() AdherenceReportSearch
int	hashCode()
AdherenceReportSearch	idFilter(String idFilter)
AdherenceReportSearch	labelFilters(List<String> labelFilters)
AdherenceReportSearch	offsetBy(Integer offsetBy)
AdherenceReportSearch	pageSize(Integer pageSize)
AdherenceReportSearch	progressionFilters(List<ParticipantStudyProgress> progressionFilters)
void	setAdherenceMax(Integer adherenceMax)
void	setAdherenceMin(Integer adherenceMin)
void	setIdFilter(String idFilter)
void	setLabelFilters(List<String> labelFilters)
void	setOffsetBy(Integer offsetBy)
void	setPageSize(Integer pageSize)
void	setProgressionFilters(List<ParticipantStudyProgress> progressionFilters)
void	setTestFilter(TestFilter testFilter)
AdherenceReportSearch	testFilter(TestFilter testFilter)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdherenceReportSearch

public AdherenceReportSearch()

Method Detail

testFilter

public AdherenceReportSearch testFilter(TestFilter testFilter)

getTestFilter

public TestFilter getTestFilter()

Return test, production, or both kinds of records. If the caller is a developer without access to production records, this field will be ignored and only test records will be returned.

Returns:

testFilter

setTestFilter

public void setTestFilter(TestFilter testFilter)

labelFilters

public AdherenceReportSearch labelFilters(List<String> labelFilters)

addLabelFiltersItem

public AdherenceReportSearch addLabelFiltersItem(String labelFiltersItem)

getLabelFilters

public List<String> getLabelFilters()

Return records where the labels of the entries includes one or more of the labels in this array.

Returns:

labelFilters

setLabelFilters

public void setLabelFilters(List<String> labelFilters)

adherenceMin

public AdherenceReportSearch adherenceMin(Integer adherenceMin)

getAdherenceMin

public Integer getAdherenceMin()

Only return records with a weekly adherence at or above this value.

Returns:

adherenceMin

setAdherenceMin

public void setAdherenceMin(Integer adherenceMin)

adherenceMax

public AdherenceReportSearch adherenceMax(Integer adherenceMax)

getAdherenceMax

public Integer getAdherenceMax()

Only return records with a weekly adherence at or below this value.

Returns:

adherenceMax

setAdherenceMax

public void setAdherenceMax(Integer adherenceMax)

progressionFilters

public AdherenceReportSearch progressionFilters(List<ParticipantStudyProgress> progressionFilters)

addProgressionFiltersItem

public AdherenceReportSearch addProgressionFiltersItem(ParticipantStudyProgress progressionFiltersItem)

getProgressionFilters

public List<ParticipantStudyProgress> getProgressionFilters()

Filter records by whether the participant has finished, not yet begun, and/or is currently participating in the study.

Returns:

progressionFilters

setProgressionFilters

public void setProgressionFilters(List<ParticipantStudyProgress> progressionFilters)

idFilter

public AdherenceReportSearch idFilter(String idFilter)

getIdFilter

public String getIdFilter()

Only return records where one of the participant’s identifier fields (externalId, identifier, firstName, lastName, email, or phone number) includes the `idFilter` string.

Returns:

idFilter

setIdFilter

public void setIdFilter(String idFilter)

offsetBy

public AdherenceReportSearch offsetBy(Integer offsetBy)

getOffsetBy

public Integer getOffsetBy()

Get offsetBy

Returns:

offsetBy

setOffsetBy

public void setOffsetBy(Integer offsetBy)

pageSize

public AdherenceReportSearch pageSize(Integer pageSize)

getPageSize

public Integer getPageSize()

Get pageSize

Returns:

pageSize

setPageSize

public void setPageSize(Integer pageSize)

getType

public String getType()

AdherenceReportSearch

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