org.sagebionetworks.bridge.rest.model

Class Criteria

java.lang.Object

org.sagebionetworks.bridge.rest.model.Criteria

@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2023-07-13T01:30:51.265Z")
public class Criteria
extends Object

Some objects, like Subpopulations and the schedules in a CriteriaScheduleStrategy, are matched against user criteria in order to return the correct object. The criteria against which user information will be matched are described in the Criteria object. See [Customizing Content for Participants](/articles/filtering.html) for a fuller explanation.

Constructor Summary

Constructors

Constructor and Description
Criteria()

Method Summary

Modifier and Type	Method and Description
Criteria	addAllOfGroupsItem(String allOfGroupsItem)
Criteria	addAllOfStudyIdsItem(String allOfStudyIdsItem)
Criteria	addNoneOfGroupsItem(String noneOfGroupsItem)
Criteria	addNoneOfStudyIdsItem(String noneOfStudyIdsItem)
Criteria	allOfGroups(List<String> allOfGroups)
Criteria	allOfStudyIds(List<String> allOfStudyIds)
boolean	equals(Object o)
List<String>	getAllOfGroups() One or more data groups; the user must have all these data groups to match.
List<String>	getAllOfStudyIds() One or more study IDs; the user must be assigned to all these studies to match.
String	getLanguage() A two-letter language code.
Map<String,Integer>	getMaxAppVersions() A map of operating system names to minimum app versions.
Map<String,Integer>	getMinAppVersions() A map of operating system names to minimum app versions.
List<String>	getNoneOfGroups() One or more data groups; the user must have none of these data groups to match.
List<String>	getNoneOfStudyIds() One or more study IDs; the user cannot be assigned to any of these studies for the associated object to match.
String	getType() Criteria
int	hashCode()
Criteria	language(String language)
Criteria	maxAppVersions(Map<String,Integer> maxAppVersions)
Criteria	minAppVersions(Map<String,Integer> minAppVersions)
Criteria	noneOfGroups(List<String> noneOfGroups)
Criteria	noneOfStudyIds(List<String> noneOfStudyIds)
Criteria	putMaxAppVersionsItem(String key, Integer maxAppVersionsItem)
Criteria	putMinAppVersionsItem(String key, Integer minAppVersionsItem)
void	setAllOfGroups(List<String> allOfGroups)
void	setAllOfStudyIds(List<String> allOfStudyIds)
void	setLanguage(String language)
void	setMaxAppVersions(Map<String,Integer> maxAppVersions)
void	setMinAppVersions(Map<String,Integer> minAppVersions)
void	setNoneOfGroups(List<String> noneOfGroups)
void	setNoneOfStudyIds(List<String> noneOfStudyIds)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Criteria

public Criteria()

Method Detail

language

public Criteria language(String language)

getLanguage

public String getLanguage()

A two-letter language code. The the must declare an `Accept-Language` header with this language in order to match this object.

Returns:

language

setLanguage

public void setLanguage(String language)

allOfGroups

public Criteria allOfGroups(List<String> allOfGroups)

addAllOfGroupsItem

public Criteria addAllOfGroupsItem(String allOfGroupsItem)

getAllOfGroups

public List<String> getAllOfGroups()

One or more data groups; the user must have all these data groups to match.

Returns:

allOfGroups

setAllOfGroups

public void setAllOfGroups(List<String> allOfGroups)

noneOfGroups

public Criteria noneOfGroups(List<String> noneOfGroups)

addNoneOfGroupsItem

public Criteria addNoneOfGroupsItem(String noneOfGroupsItem)

getNoneOfGroups

public List<String> getNoneOfGroups()

One or more data groups; the user must have none of these data groups to match.

Returns:

noneOfGroups

setNoneOfGroups

public void setNoneOfGroups(List<String> noneOfGroups)

allOfStudyIds

public Criteria allOfStudyIds(List<String> allOfStudyIds)

addAllOfStudyIdsItem

public Criteria addAllOfStudyIdsItem(String allOfStudyIdsItem)

getAllOfStudyIds

public List<String> getAllOfStudyIds()

One or more study IDs; the user must be assigned to all these studies to match.

Returns:

allOfStudyIds

setAllOfStudyIds

public void setAllOfStudyIds(List<String> allOfStudyIds)

noneOfStudyIds

public Criteria noneOfStudyIds(List<String> noneOfStudyIds)

addNoneOfStudyIdsItem

public Criteria addNoneOfStudyIdsItem(String noneOfStudyIdsItem)

getNoneOfStudyIds

public List<String> getNoneOfStudyIds()

One or more study IDs; the user cannot be assigned to any of these studies for the associated object to match.

Returns:

noneOfStudyIds

setNoneOfStudyIds

public void setNoneOfStudyIds(List<String> noneOfStudyIds)

minAppVersions

public Criteria minAppVersions(Map<String,Integer> minAppVersions)

putMinAppVersionsItem

public Criteria putMinAppVersionsItem(String key,
                                      Integer minAppVersionsItem)

getMinAppVersions

public Map<String,Integer> getMinAppVersions()

A map of operating system names to minimum app versions. The user must send a `User-Agent` header in a prescribed format, that declares the app version to be equal to or greater than this version number, in order to match.

Returns:

minAppVersions

setMinAppVersions

public void setMinAppVersions(Map<String,Integer> minAppVersions)

maxAppVersions

public Criteria maxAppVersions(Map<String,Integer> maxAppVersions)

putMaxAppVersionsItem

public Criteria putMaxAppVersionsItem(String key,
                                      Integer maxAppVersionsItem)

getMaxAppVersions

public Map<String,Integer> getMaxAppVersions()

A map of operating system names to minimum app versions. The user must send a `User-Agent` header in a prescribed format, that declares the app version to be equal to or less than this version number, in order to match.

Returns:

maxAppVersions

setMaxAppVersions

public void setMaxAppVersions(Map<String,Integer> maxAppVersions)

getType

public String getType()

Criteria

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