org.sagebionetworks.bridge.rest.model

Class AccountSummarySearch

java.lang.Object

org.sagebionetworks.bridge.rest.model.AccountSummarySearch

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

Search criteria to retrieve account summaries of study participants. All of these search fields are filters. All records will bre returned unless a search criteria is provided, which will be used to filter the accounts that are returned (all supplied filter criteria must match). Fields that end with `filter` are interpreted as strings that can be matched anywhere in the target field (so for example, `emailFilter` can match accounts with the `@gmail.com` domain).

Constructor Summary

Constructors

Constructor and Description
AccountSummarySearch()

Method Summary

Modifier and Type	Method and Description
AccountSummarySearch	addAllOfGroupsItem(String allOfGroupsItem)
AccountSummarySearch	addNoneOfGroupsItem(String noneOfGroupsItem)
AccountSummarySearch	adminOnly(Boolean adminOnly)
AccountSummarySearch	allOfGroups(List<String> allOfGroups)
AccountSummarySearch	attributeKey(String attributeKey)
AccountSummarySearch	attributeValueFilter(String attributeValueFilter)
AccountSummarySearch	emailFilter(String emailFilter)
AccountSummarySearch	endTime(DateTime endTime)
AccountSummarySearch	enrolledInStudyId(String enrolledInStudyId)
AccountSummarySearch	enrollment(EnrollmentFilter enrollment)
boolean	equals(Object o)
AccountSummarySearch	externalIdFilter(String externalIdFilter)
List<String>	getAllOfGroups() Return records that have all of these data groups
String	getAttributeKey() Return records that have an attribute with this key and a value that matches the substring value specified by `attributeValueFilter`.
String	getAttributeValueFilter() Return records that have an attribute key specified by `attributeKey` and a value that matches the substring value of `attributeValueFilter`.
String	getEmailFilter() Return records that match this substring in their email address
DateTime	getEndTime() Return record created on or before this day
String	getEnrolledInStudyId() Return records that are enrolled in a study (specified by the study’s ID).
EnrollmentFilter	getEnrollment() Return records that match this enrollment state.
String	getExternalIdFilter() Return records that match this value as a substring of an external ID.
String	getLanguage() Return records that declare this language as a language preference
List<String>	getNoneOfGroups() Return records that have none of these data groups
Integer	getOffsetBy() Next page start offset for pagination
String	getOrgMembership() Return records that are members of this organization (specified by the organization’s ID).
Integer	getPageSize() Maximum number of records in each returned page maximum: 100
String	getPhoneFilter() Return records that match this substring in their phone number
SearchTermPredicate	getPredicate() How search criteria should be evaluated in a search (whether any criteria or all criteria must match).
DateTime	getStartTime() Return record created on or after this day
AccountStatus	getStatus() Return records that match this status.
StringSearchPosition	getStringSearchPosition() How string-based search criteria will be compared to values in a record.
String	getType() AccountSummarySearch
int	hashCode()
AccountSummarySearch	inUse(Boolean inUse)
Boolean	isAdminOnly() Return records that have one or more administrative roles.
Boolean	isInUse() If true, the accounts returned will have signed in to the Bridge server at least once; if false, the accounts returned will never have signed in to the Bridge server.
AccountSummarySearch	language(String language)
AccountSummarySearch	noneOfGroups(List<String> noneOfGroups)
AccountSummarySearch	offsetBy(Integer offsetBy)
AccountSummarySearch	orgMembership(String orgMembership)
AccountSummarySearch	pageSize(Integer pageSize)
AccountSummarySearch	phoneFilter(String phoneFilter)
AccountSummarySearch	predicate(SearchTermPredicate predicate)
void	setAdminOnly(Boolean adminOnly)
void	setAllOfGroups(List<String> allOfGroups)
void	setAttributeKey(String attributeKey)
void	setAttributeValueFilter(String attributeValueFilter)
void	setEmailFilter(String emailFilter)
void	setEndTime(DateTime endTime)
void	setEnrolledInStudyId(String enrolledInStudyId)
void	setEnrollment(EnrollmentFilter enrollment)
void	setExternalIdFilter(String externalIdFilter)
void	setInUse(Boolean inUse)
void	setLanguage(String language)
void	setNoneOfGroups(List<String> noneOfGroups)
void	setOffsetBy(Integer offsetBy)
void	setOrgMembership(String orgMembership)
void	setPageSize(Integer pageSize)
void	setPhoneFilter(String phoneFilter)
void	setPredicate(SearchTermPredicate predicate)
void	setStartTime(DateTime startTime)
void	setStatus(AccountStatus status)
void	setStringSearchPosition(StringSearchPosition stringSearchPosition)
AccountSummarySearch	startTime(DateTime startTime)
AccountSummarySearch	status(AccountStatus status)
AccountSummarySearch	stringSearchPosition(StringSearchPosition stringSearchPosition)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AccountSummarySearch

public AccountSummarySearch()

Method Detail

pageSize

public AccountSummarySearch pageSize(Integer pageSize)

getPageSize

public Integer getPageSize()

Maximum number of records in each returned page maximum: 100

Returns:

pageSize

setPageSize

public void setPageSize(Integer pageSize)

offsetBy

public AccountSummarySearch offsetBy(Integer offsetBy)

getOffsetBy

public Integer getOffsetBy()

Next page start offset for pagination

Returns:

offsetBy

setOffsetBy

public void setOffsetBy(Integer offsetBy)

emailFilter

public AccountSummarySearch emailFilter(String emailFilter)

getEmailFilter

public String getEmailFilter()

Return records that match this substring in their email address

Returns:

emailFilter

setEmailFilter

public void setEmailFilter(String emailFilter)

phoneFilter

public AccountSummarySearch phoneFilter(String phoneFilter)

getPhoneFilter

public String getPhoneFilter()

Return records that match this substring in their phone number

Returns:

phoneFilter

setPhoneFilter

public void setPhoneFilter(String phoneFilter)

allOfGroups

public AccountSummarySearch allOfGroups(List<String> allOfGroups)

addAllOfGroupsItem

public AccountSummarySearch addAllOfGroupsItem(String allOfGroupsItem)

getAllOfGroups

public List<String> getAllOfGroups()

Return records that have all of these data groups

Returns:

allOfGroups

setAllOfGroups

public void setAllOfGroups(List<String> allOfGroups)

noneOfGroups

public AccountSummarySearch noneOfGroups(List<String> noneOfGroups)

addNoneOfGroupsItem

public AccountSummarySearch addNoneOfGroupsItem(String noneOfGroupsItem)

getNoneOfGroups

public List<String> getNoneOfGroups()

Return records that have none of these data groups

Returns:

noneOfGroups

setNoneOfGroups

public void setNoneOfGroups(List<String> noneOfGroups)

language

public AccountSummarySearch language(String language)

getLanguage

public String getLanguage()

Return records that declare this language as a language preference

Returns:

language

setLanguage

public void setLanguage(String language)

startTime

public AccountSummarySearch startTime(DateTime startTime)

getStartTime

public DateTime getStartTime()

Return record created on or after this day

Returns:

startTime

setStartTime

public void setStartTime(DateTime startTime)

endTime

public AccountSummarySearch endTime(DateTime endTime)

getEndTime

public DateTime getEndTime()

Return record created on or before this day

Returns:

endTime

setEndTime

public void setEndTime(DateTime endTime)

orgMembership

public AccountSummarySearch orgMembership(String orgMembership)

getOrgMembership

public String getOrgMembership()

Return records that are members of this organization (specified by the organization’s ID). The keyword \"<none>\" can be used to retrieve accounts that are *not* assigned to any organization.

Returns:

orgMembership

setOrgMembership

public void setOrgMembership(String orgMembership)

adminOnly

public AccountSummarySearch adminOnly(Boolean adminOnly)

isAdminOnly

public Boolean isAdminOnly()

Return records that have one or more administrative roles.

Returns:

adminOnly

setAdminOnly

public void setAdminOnly(Boolean adminOnly)

enrolledInStudyId

public AccountSummarySearch enrolledInStudyId(String enrolledInStudyId)

getEnrolledInStudyId

public String getEnrolledInStudyId()

Return records that are enrolled in a study (specified by the study’s ID). These accounts have an enrollment record, but they may be enrolled or withdrawn from the study.

Returns:

enrolledInStudyId

setEnrolledInStudyId

public void setEnrolledInStudyId(String enrolledInStudyId)

externalIdFilter

public AccountSummarySearch externalIdFilter(String externalIdFilter)

getExternalIdFilter

public String getExternalIdFilter()

Return records that match this value as a substring of an external ID. In the context of a specific study, this search will only be conducted on the external IDs for that study (in app-scoped APIs, it matches against all external IDs assigned to the account).

Returns:

externalIdFilter

setExternalIdFilter

public void setExternalIdFilter(String externalIdFilter)

status

public AccountSummarySearch status(AccountStatus status)

getStatus

public AccountStatus getStatus()

Return records that match this status.

Returns:

status

setStatus

public void setStatus(AccountStatus status)

enrollment

public AccountSummarySearch enrollment(EnrollmentFilter enrollment)

getEnrollment

public EnrollmentFilter getEnrollment()

Return records that match this enrollment state. In the context of a specific study, this search will only be conducted on accounts enrolled in that study. In app-scoped APIs, it matches any account that has at least one enrollment in the selected enrollment state.

Returns:

enrollment

setEnrollment

public void setEnrollment(EnrollmentFilter enrollment)

attributeKey

public AccountSummarySearch attributeKey(String attributeKey)

getAttributeKey

public String getAttributeKey()

Return records that have an attribute with this key and a value that matches the substring value specified by `attributeValueFilter`.

Returns:

attributeKey

setAttributeKey

public void setAttributeKey(String attributeKey)

attributeValueFilter

public AccountSummarySearch attributeValueFilter(String attributeValueFilter)

getAttributeValueFilter

public String getAttributeValueFilter()

Return records that have an attribute key specified by `attributeKey` and a value that matches the substring value of `attributeValueFilter`.

Returns:

attributeValueFilter

setAttributeValueFilter

public void setAttributeValueFilter(String attributeValueFilter)

predicate

public AccountSummarySearch predicate(SearchTermPredicate predicate)

getPredicate

public SearchTermPredicate getPredicate()

How search criteria should be evaluated in a search (whether any criteria or all criteria must match).

Returns:

predicate

setPredicate

public void setPredicate(SearchTermPredicate predicate)

stringSearchPosition

public AccountSummarySearch stringSearchPosition(StringSearchPosition stringSearchPosition)

getStringSearchPosition

public StringSearchPosition getStringSearchPosition()

How string-based search criteria will be compared to values in a record.

Returns:

stringSearchPosition

setStringSearchPosition

public void setStringSearchPosition(StringSearchPosition stringSearchPosition)

inUse

public AccountSummarySearch inUse(Boolean inUse)

isInUse

public Boolean isInUse()

If true, the accounts returned will have signed in to the Bridge server at least once; if false, the accounts returned will never have signed in to the Bridge server. If omitted, all accounts are returned regardless of sign-in status.

Returns:

inUse

setInUse

public void setInUse(Boolean inUse)

getType

public String getType()

AccountSummarySearch

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