AdherenceRecordsSearch (REST Client 0.25.15 API)

java.lang.Object
- org.sagebionetworks.bridge.rest.model.AdherenceRecordsSearch

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

AdherenceRecordsSearch

Constructor Summary

Constructors
Constructor and Description

AdherenceRecordsSearch()

Constructors
Constructor and Description
`AdherenceRecordsSearch()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`eventTimestamps(Map<String,DateTime> eventTimestamps)`
`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).
`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.
`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
`int`	`hashCode()`
`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`	`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`	`setEventTimestamps(Map<String,DateTime> eventTimestamps)`
`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)`
`AdherenceRecordsSearch`	`sortOrder(SortOrder sortOrder)`
`AdherenceRecordsSearch`	`startTime(DateTime startTime)`
`AdherenceRecordsSearch`	`stringSearchPosition(StringSearchPosition stringSearchPosition)`
`AdherenceRecordsSearch`	`timeWindowGuids(List<String> timeWindowGuids)`
`String`	`toString()`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AdherenceRecordsSearch
```
public AdherenceRecordsSearch()
```
- Method Detail
  - instanceGuids
```
public AdherenceRecordsSearch instanceGuids(List<String> instanceGuids)
```
  - addInstanceGuidsItem
```
public AdherenceRecordsSearch addInstanceGuidsItem(String instanceGuidsItem)
```
  - getInstanceGuids
```
public List<String> getInstanceGuids()
```
    Session or assessment instance GUIDs. Any records that exist with these GUIDs will be returned (scoped to a specific participant in a specific study). If the assessment is a persistent assessment, all adherence records for that assessment will be returned unless includeRepeats is false. This array cannot contain more than 500 items.
    
    Returns:
    
    instanceGuids
  - setInstanceGuids
```
public void setInstanceGuids(List<String> instanceGuids)
```
  - assessmentIds
```
public AdherenceRecordsSearch assessmentIds(List<String> assessmentIds)
```
  - addAssessmentIdsItem
```
public AdherenceRecordsSearch addAssessmentIdsItem(String assessmentIdsItem)
```
  - getAssessmentIds
```
public List<String> getAssessmentIds()
```
    Return adherence records for assessments with these IDs (the assessment ID is used to define a type of assessment). This array cannot contain more than 500 items.
    
    Returns:
    
    assessmentIds
  - setAssessmentIds
```
public void setAssessmentIds(List<String> assessmentIds)
```
  - sessionGuids
```
public AdherenceRecordsSearch sessionGuids(List<String> sessionGuids)
```
  - addSessionGuidsItem
```
public AdherenceRecordsSearch addSessionGuidsItem(String sessionGuidsItem)
```
  - getSessionGuids
```
public 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). This array cannot contain more than 500 items.
    
    Returns:
    
    sessionGuids
  - setSessionGuids
```
public void setSessionGuids(List<String> sessionGuids)
```
  - timeWindowGuids
```
public AdherenceRecordsSearch timeWindowGuids(List<String> timeWindowGuids)
```
  - addTimeWindowGuidsItem
```
public AdherenceRecordsSearch addTimeWindowGuidsItem(String timeWindowGuidsItem)
```
  - getTimeWindowGuids
```
public 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). This array cannot contain more than 500 items.
    
    Returns:
    
    timeWindowGuids
  - setTimeWindowGuids
```
public void setTimeWindowGuids(List<String> timeWindowGuids)
```
  - adherenceRecordType
```
public AdherenceRecordsSearch adherenceRecordType(AdherenceRecordType adherenceRecordType)
```
  - getAdherenceRecordType
```
public AdherenceRecordType getAdherenceRecordType()
```
    Get adherenceRecordType
    
    Returns:
    
    adherenceRecordType
  - setAdherenceRecordType
```
public void setAdherenceRecordType(AdherenceRecordType adherenceRecordType)
```
  - includeRepeats
```
public AdherenceRecordsSearch includeRepeats(Boolean includeRepeats)
```
  - isIncludeRepeats
```
public 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. In this case, the first or last record only will be returned (depending on sort order).
    
    Returns:
    
    includeRepeats
  - setIncludeRepeats
```
public void setIncludeRepeats(Boolean includeRepeats)
```
  - currentTimestampsOnly
```
public AdherenceRecordsSearch currentTimestampsOnly(Boolean currentTimestampsOnly)
```
  - isCurrentTimestampsOnly
```
public 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. When true, only records with recent event timestamp values will be returned. This is equivalent to sending back the user’s entire map of current event ID timestamp values via the `eventTimestamps` map in this search object. If values are also provided in the `eventTimestamps` map, each of those event IDs will override its associated event ID timestamp value, as it is provided by setting this flag to true.
    
    Returns:
    
    currentTimestampsOnly
  - setCurrentTimestampsOnly
```
public void setCurrentTimestampsOnly(Boolean currentTimestampsOnly)
```
  - eventTimestamps
```
public AdherenceRecordsSearch eventTimestamps(Map<String,DateTime> eventTimestamps)
```
  - putEventTimestampsItem
```
public AdherenceRecordsSearch putEventTimestampsItem(String key,
                                                     DateTime eventTimestampsItem)
```
  - getEventTimestamps
```
public 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. Only records with that exact timestamp value in their `eventTimestamp` field will be returned. In general, mobile clients will only want to retrieve records for current timestamp values when calculating schedules, so the `currentTimestampsOnly` flag provides an easy way to request that all current timestamps be used to limit search results. This map cannot contain more than 50 entries.
    
    Returns:
    
    eventTimestamps
  - setEventTimestamps
```
public void setEventTimestamps(Map<String,DateTime> eventTimestamps)
```
  - startTime
```
public AdherenceRecordsSearch startTime(DateTime startTime)
```
  - getStartTime
```
public 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).
    
    Returns:
    
    startTime
  - setStartTime
```
public void setStartTime(DateTime startTime)
```
  - endTime
```
public AdherenceRecordsSearch endTime(DateTime endTime)
```
  - getEndTime
```
public 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).
    
    Returns:
    
    endTime
  - setEndTime
```
public void setEndTime(DateTime endTime)
```
  - pageSize
```
public AdherenceRecordsSearch pageSize(Integer pageSize)
```
  - getPageSize
```
public Integer getPageSize()
```
    The maximum number of records in each returned page. Range can be from 1-500 records.
    
    Returns:
    
    pageSize
  - setPageSize
```
public void setPageSize(Integer pageSize)
```
  - offsetBy
```
public AdherenceRecordsSearch offsetBy(Integer offsetBy)
```
  - getOffsetBy
```
public Integer getOffsetBy()
```
    The next page start offset for pagination.
    
    Returns:
    
    offsetBy
  - setOffsetBy
```
public void setOffsetBy(Integer offsetBy)
```
  - sortOrder
```
public AdherenceRecordsSearch sortOrder(SortOrder sortOrder)
```
  - getSortOrder
```
public SortOrder getSortOrder()
```
    Get sortOrder
    
    Returns:
    
    sortOrder
  - setSortOrder
```
public void setSortOrder(SortOrder sortOrder)
```
  - predicate
```
public AdherenceRecordsSearch 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 AdherenceRecordsSearch 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)
```
  - declined
```
public AdherenceRecordsSearch declined(Boolean declined)
```
  - isDeclined
```
public Boolean isDeclined()
```
    Return records that were declined or that were not declined. Assessments are directly declined by participants; a session record will be marked declined if all of its assessments were declined.
    
    Returns:
    
    declined
  - setDeclined
```
public void setDeclined(Boolean declined)
```
  - getType
```
public String getType()
```
    AdherenceRecordsSearch
    
    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

Class AdherenceRecordsSearch

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AdherenceRecordsSearch

Method Detail

instanceGuids

addInstanceGuidsItem

getInstanceGuids

setInstanceGuids

assessmentIds

addAssessmentIdsItem

getAssessmentIds

setAssessmentIds

sessionGuids

addSessionGuidsItem

getSessionGuids

setSessionGuids

timeWindowGuids

addTimeWindowGuidsItem

getTimeWindowGuids

setTimeWindowGuids

adherenceRecordType

getAdherenceRecordType

setAdherenceRecordType

includeRepeats

isIncludeRepeats

setIncludeRepeats

currentTimestampsOnly

isCurrentTimestampsOnly

setCurrentTimestampsOnly

eventTimestamps

putEventTimestampsItem

getEventTimestamps

setEventTimestamps

startTime

getStartTime

setStartTime

endTime

getEndTime

setEndTime

pageSize

getPageSize

setPageSize

offsetBy

getOffsetBy

setOffsetBy

sortOrder

getSortOrder

setSortOrder

predicate

getPredicate

setPredicate

stringSearchPosition

getStringSearchPosition

setStringSearchPosition

declined

isDeclined

setDeclined

getType

equals

hashCode

toString