@Generated(value="io.swagger.codegen.languages.JavaClientCodegen", date="2023-05-18T04:52:40.966Z") public class AdherenceRecordsSearch extends Object
Constructor and Description |
---|
AdherenceRecordsSearch() |
Modifier and Type | Method and Description |
---|---|
AdherenceRecordsSearch |
addAssessmentIdsItem(String assessmentIdsItem) |
AdherenceRecordsSearch |
addInstanceGuidsItem(String instanceGuidsItem) |
AdherenceRecordsSearch |
addSessionGuidsItem(String sessionGuidsItem) |
AdherenceRecordsSearch |
addTimeWindowGuidsItem(String timeWindowGuidsItem) |
AdherenceRecordsSearch |
adherenceRecordType(AdherenceRecordType adherenceRecordType) |
AdherenceRecordsSearch |
assessmentIds(List<String> assessmentIds) |
AdherenceRecordsSearch |
currentTimestampsOnly(Boolean currentTimestampsOnly) |
AdherenceRecordsSearch |
declined(Boolean declined) |
AdherenceRecordsSearch |
endTime(DateTime endTime) |
boolean |
equals(Object o) |
AdherenceRecordsSearch |
eventTimestampEnd(DateTime eventTimestampEnd) |
AdherenceRecordsSearch |
eventTimestamps(Map<String,DateTime> eventTimestamps) |
AdherenceRecordsSearch |
eventTimestampStart(DateTime eventTimestampStart) |
AdherenceRecordType |
getAdherenceRecordType()
Get adherenceRecordType
|
List<String> |
getAssessmentIds()
Return adherence records for assessments with these IDs (the assessment ID is used to define a type of assessment).
|
DateTime |
getEndTime()
Limit search results to records with `startedOn` values that are equal to or earlier than this end time (no later than January 1st, 2120).
|
DateTime |
getEventTimestampEnd()
Return records where the `eventTimestamp` value of the record is before the timestamp provided, but not on.
|
Map<String,DateTime> |
getEventTimestamps()
A mapping of event IDs to timestamp values to use when retrieving adherence records that are from sessions triggered by that ID.
|
DateTime |
getEventTimestampStart()
Return records where the `eventTimestamp` value of the record is on or after the timestamp provided.
|
List<String> |
getInstanceGuids()
Session or assessment instance GUIDs.
|
Integer |
getOffsetBy()
The next page start offset for pagination.
|
Integer |
getPageSize()
The maximum number of records in each returned page.
|
SearchTermPredicate |
getPredicate()
How search criteria should be evaluated in a search (whether any criteria or all criteria must match).
|
List<String> |
getSessionGuids()
Return adherence records for sessions with these GUIDs (this is the session’s GUID in a schedule and not an instance GUID, and is used to define a type of session).
|
SortOrder |
getSortOrder()
Get sortOrder
|
DateTime |
getStartTime()
Limit search results to records with `startedOn` values that are equal to or later than this start time (no earlier than January 1st, 2020).
|
StringSearchPosition |
getStringSearchPosition()
How string-based search criteria will be compared to values in a record.
|
List<String> |
getTimeWindowGuids()
Return adherence records for assessments in these time windows (using the time window’s GUID in a schedule to define a type of time window).
|
String |
getType()
AdherenceRecordsSearch
|
String |
getUploadId()
Search for a specific upload ID.
|
int |
hashCode() |
AdherenceRecordsSearch |
hasMultipleUploadIds(Boolean hasMultipleUploadIds) |
AdherenceRecordsSearch |
hasNoUploadIds(Boolean hasNoUploadIds) |
AdherenceRecordsSearch |
includeRepeats(Boolean includeRepeats) |
AdherenceRecordsSearch |
instanceGuids(List<String> instanceGuids) |
Boolean |
isCurrentTimestampsOnly()
Where a time series can be performed multiple times because a session’s trigger event is mutable, all records will be returned, unless this flag is set to true.
|
Boolean |
isDeclined()
Return records that were declined or that were not declined.
|
Boolean |
isHasMultipleUploadIds()
Return only adherence records associated with multiple upload IDs.
|
Boolean |
isHasNoUploadIds()
Return only adherence records associated with no upload IDs.
|
Boolean |
isIncludeRepeats()
Where an assessment can be performed multiple times under an instance GUID, all records will be returned unless this flag is set to true.
|
AdherenceRecordsSearch |
offsetBy(Integer offsetBy) |
AdherenceRecordsSearch |
pageSize(Integer pageSize) |
AdherenceRecordsSearch |
predicate(SearchTermPredicate predicate) |
AdherenceRecordsSearch |
putEventTimestampsItem(String key,
DateTime eventTimestampsItem) |
AdherenceRecordsSearch |
sessionGuids(List<String> sessionGuids) |
void |
setAdherenceRecordType(AdherenceRecordType adherenceRecordType) |
void |
setAssessmentIds(List<String> assessmentIds) |
void |
setCurrentTimestampsOnly(Boolean currentTimestampsOnly) |
void |
setDeclined(Boolean declined) |
void |
setEndTime(DateTime endTime) |
void |
setEventTimestampEnd(DateTime eventTimestampEnd) |
void |
setEventTimestamps(Map<String,DateTime> eventTimestamps) |
void |
setEventTimestampStart(DateTime eventTimestampStart) |
void |
setHasMultipleUploadIds(Boolean hasMultipleUploadIds) |
void |
setHasNoUploadIds(Boolean hasNoUploadIds) |
void |
setIncludeRepeats(Boolean includeRepeats) |
void |
setInstanceGuids(List<String> instanceGuids) |
void |
setOffsetBy(Integer offsetBy) |
void |
setPageSize(Integer pageSize) |
void |
setPredicate(SearchTermPredicate predicate) |
void |
setSessionGuids(List<String> sessionGuids) |
void |
setSortOrder(SortOrder sortOrder) |
void |
setStartTime(DateTime startTime) |
void |
setStringSearchPosition(StringSearchPosition stringSearchPosition) |
void |
setTimeWindowGuids(List<String> timeWindowGuids) |
void |
setUploadId(String uploadId) |
AdherenceRecordsSearch |
sortOrder(SortOrder sortOrder) |
AdherenceRecordsSearch |
startTime(DateTime startTime) |
AdherenceRecordsSearch |
stringSearchPosition(StringSearchPosition stringSearchPosition) |
AdherenceRecordsSearch |
timeWindowGuids(List<String> timeWindowGuids) |
String |
toString() |
AdherenceRecordsSearch |
uploadId(String uploadId) |
public AdherenceRecordsSearch instanceGuids(List<String> instanceGuids)
public AdherenceRecordsSearch addInstanceGuidsItem(String instanceGuidsItem)
public List<String> getInstanceGuids()
public AdherenceRecordsSearch assessmentIds(List<String> assessmentIds)
public AdherenceRecordsSearch addAssessmentIdsItem(String assessmentIdsItem)
public List<String> getAssessmentIds()
public AdherenceRecordsSearch sessionGuids(List<String> sessionGuids)
public AdherenceRecordsSearch addSessionGuidsItem(String sessionGuidsItem)
public List<String> getSessionGuids()
public AdherenceRecordsSearch timeWindowGuids(List<String> timeWindowGuids)
public AdherenceRecordsSearch addTimeWindowGuidsItem(String timeWindowGuidsItem)
public List<String> getTimeWindowGuids()
public AdherenceRecordsSearch adherenceRecordType(AdherenceRecordType adherenceRecordType)
public AdherenceRecordType getAdherenceRecordType()
public void setAdherenceRecordType(AdherenceRecordType adherenceRecordType)
public AdherenceRecordsSearch includeRepeats(Boolean includeRepeats)
public Boolean isIncludeRepeats()
public void setIncludeRepeats(Boolean includeRepeats)
public AdherenceRecordsSearch currentTimestampsOnly(Boolean currentTimestampsOnly)
public Boolean isCurrentTimestampsOnly()
public void setCurrentTimestampsOnly(Boolean currentTimestampsOnly)
public AdherenceRecordsSearch eventTimestamps(Map<String,DateTime> eventTimestamps)
public AdherenceRecordsSearch putEventTimestampsItem(String key, DateTime eventTimestampsItem)
public Map<String,DateTime> getEventTimestamps()
public AdherenceRecordsSearch eventTimestampStart(DateTime eventTimestampStart)
public DateTime getEventTimestampStart()
public void setEventTimestampStart(DateTime eventTimestampStart)
public AdherenceRecordsSearch eventTimestampEnd(DateTime eventTimestampEnd)
public DateTime getEventTimestampEnd()
public void setEventTimestampEnd(DateTime eventTimestampEnd)
public AdherenceRecordsSearch startTime(DateTime startTime)
public DateTime getStartTime()
public void setStartTime(DateTime startTime)
public AdherenceRecordsSearch endTime(DateTime endTime)
public DateTime getEndTime()
public void setEndTime(DateTime endTime)
public AdherenceRecordsSearch pageSize(Integer pageSize)
public Integer getPageSize()
public void setPageSize(Integer pageSize)
public AdherenceRecordsSearch offsetBy(Integer offsetBy)
public Integer getOffsetBy()
public void setOffsetBy(Integer offsetBy)
public AdherenceRecordsSearch sortOrder(SortOrder sortOrder)
public SortOrder getSortOrder()
public void setSortOrder(SortOrder sortOrder)
public AdherenceRecordsSearch predicate(SearchTermPredicate predicate)
public SearchTermPredicate getPredicate()
public void setPredicate(SearchTermPredicate predicate)
public AdherenceRecordsSearch stringSearchPosition(StringSearchPosition stringSearchPosition)
public StringSearchPosition getStringSearchPosition()
public void setStringSearchPosition(StringSearchPosition stringSearchPosition)
public AdherenceRecordsSearch declined(Boolean declined)
public Boolean isDeclined()
public void setDeclined(Boolean declined)
public AdherenceRecordsSearch uploadId(String uploadId)
public String getUploadId()
public void setUploadId(String uploadId)
public AdherenceRecordsSearch hasMultipleUploadIds(Boolean hasMultipleUploadIds)
public Boolean isHasMultipleUploadIds()
public void setHasMultipleUploadIds(Boolean hasMultipleUploadIds)
public AdherenceRecordsSearch hasNoUploadIds(Boolean hasNoUploadIds)
public Boolean isHasNoUploadIds()
public void setHasNoUploadIds(Boolean hasNoUploadIds)
public String getType()
Copyright © 2023 Sage Bionetworks. All rights reserved.