StudyActivityEvent (REST Client 0.25.15 API)

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

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

Activity event for a participant in a specific study, used for scheduling activities.

Constructor Summary

Constructors
Constructor and Description

StudyActivityEvent()

Constructors
Constructor and Description
`StudyActivityEvent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StudyActivityEvent`	`clientTimeZone(String clientTimeZone)`
`boolean`	`equals(Object o)`
`StudyActivityEvent`	`eventId(String eventId)`
`String`	`getAnswerValue()` Answer value for a question event, or the iteration value for a study burst event.
`String`	`getClientTimeZone()` An IANA Time Zone Database (TZDB) name for the participant’s time zone at the time the record is submitted.
`DateTime`	`getCreatedOn()` ISO 8601 date and time that the user account was created.
`String`	`getEventId()` A string identifying this event.
`String`	`getOriginEventId()` If this event is generated from a study burst, the originating event ID that triggers the study burst to occur.
`String`	`getPeriodFromOrigin()` If the event is generated from a study burst, An ISO 8601 duration, describing the period after the originating event’s timestamp when this event has been scheduled to occur.
`Integer`	`getRecordCount()` The number of unique timestamp values that have been recorded for this event.
`String`	`getStudyBurstId()` If the event is generated from a study burst, the identifier of the study burst (note that this is also part of the value of the event ID itself).
`DateTime`	`getTimestamp()` ISO 8601 date and time that the event occurred.
`String`	`getType()` StudyActivityEvent
`ActivityEventUpdateType`	`getUpdateType()` The update type is carried over to the specific event records for informational purposes.
`int`	`hashCode()`
`StudyActivityEvent`	`originEventId(String originEventId)`
`StudyActivityEvent`	`periodFromOrigin(String periodFromOrigin)`
`StudyActivityEvent`	`recordCount(Integer recordCount)`
`void`	`setClientTimeZone(String clientTimeZone)`
`void`	`setEventId(String eventId)`
`void`	`setOriginEventId(String originEventId)`
`void`	`setPeriodFromOrigin(String periodFromOrigin)`
`void`	`setRecordCount(Integer recordCount)`
`void`	`setStudyBurstId(String studyBurstId)`
`void`	`setTimestamp(DateTime timestamp)`
`void`	`setUpdateType(ActivityEventUpdateType updateType)`
`StudyActivityEvent`	`studyBurstId(String studyBurstId)`
`StudyActivityEvent`	`timestamp(DateTime timestamp)`
`String`	`toString()`
`StudyActivityEvent`	`updateType(ActivityEventUpdateType updateType)`

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

- Constructor Detail
  - StudyActivityEvent
```
public StudyActivityEvent()
```
- Method Detail
  - eventId
```
public StudyActivityEvent eventId(String eventId)
```
  - getEventId
```
public String getEventId()
```
    A string identifying this event. The event ID must be in a specific format based on the type of event (e.g. `study_burst:foo:02` or `custom:event1`).
    
    Returns:
    
    eventId
  - setEventId
```
public void setEventId(String eventId)
```
  - getAnswerValue
```
public String getAnswerValue()
```
    Answer value for a question event, or the iteration value for a study burst event.
    
    Returns:
    
    answerValue
  - timestamp
```
public StudyActivityEvent timestamp(DateTime timestamp)
```
  - getTimestamp
```
public DateTime getTimestamp()
```
    ISO 8601 date and time that the event occurred. This timestamp may be generated by the server for system events, or it may be submitted by a client, in which case it will be according to the client’s clock which may be skewed from the server or actual time. The `createdOn` field can help to identify such clients.
    
    Returns:
    
    timestamp
  - setTimestamp
```
public void setTimestamp(DateTime timestamp)
```
  - updateType
```
public StudyActivityEvent updateType(ActivityEventUpdateType updateType)
```
  - getUpdateType
```
public ActivityEventUpdateType getUpdateType()
```
    The update type is carried over to the specific event records for informational purposes.
    
    Returns:
    
    updateType
  - setUpdateType
```
public void setUpdateType(ActivityEventUpdateType updateType)
```
  - clientTimeZone
```
public StudyActivityEvent clientTimeZone(String clientTimeZone)
```
  - getClientTimeZone
```
public String getClientTimeZone()
```
    An IANA Time Zone Database (TZDB) name for the participant’s time zone at the time the record is submitted. If present, this field will be validated to be a valid time zone name. If this event is an origin event for a study burst, the client time zone will be copied into the study burst events that are generated.
    
    Returns:
    
    clientTimeZone
  - setClientTimeZone
```
public void setClientTimeZone(String clientTimeZone)
```
  - originEventId
```
public StudyActivityEvent originEventId(String originEventId)
```
  - getOriginEventId
```
public String getOriginEventId()
```
    If this event is generated from a study burst, the originating event ID that triggers the study burst to occur. Available for tools to order events in UIs.
    
    Returns:
    
    originEventId
  - setOriginEventId
```
public void setOriginEventId(String originEventId)
```
  - studyBurstId
```
public StudyActivityEvent studyBurstId(String studyBurstId)
```
  - getStudyBurstId
```
public String getStudyBurstId()
```
    If the event is generated from a study burst, the identifier of the study burst (note that this is also part of the value of the event ID itself).
    
    Returns:
    
    studyBurstId
  - setStudyBurstId
```
public void setStudyBurstId(String studyBurstId)
```
  - periodFromOrigin
```
public StudyActivityEvent periodFromOrigin(String periodFromOrigin)
```
  - getPeriodFromOrigin
```
public String getPeriodFromOrigin()
```
    If the event is generated from a study burst, An ISO 8601 duration, describing the period after the originating event’s timestamp when this event has been scheduled to occur. This value increments with each study burst event in the sequence by the interval value of the study burst itself.
    
    Returns:
    
    periodFromOrigin
  - setPeriodFromOrigin
```
public void setPeriodFromOrigin(String periodFromOrigin)
```
  - recordCount
```
public StudyActivityEvent recordCount(Integer recordCount)
```
  - getRecordCount
```
public Integer getRecordCount()
```
    The number of unique timestamp values that have been recorded for this event. This field is present in list views, but not when this individual event is retrieved from the server. Immutable events should only ever have one record, while mutable events (`future_only` and `mutable`) can have any number of historical values.
    
    Returns:
    
    recordCount
  - setRecordCount
```
public void setRecordCount(Integer recordCount)
```
  - getCreatedOn
```
public DateTime getCreatedOn()
```
    ISO 8601 date and time that the user account was created.
    
    Returns:
    
    createdOn
  - getType
```
public String getType()
```
    StudyActivityEvent
    
    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 StudyActivityEvent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StudyActivityEvent

Method Detail

eventId

getEventId

setEventId

getAnswerValue

timestamp

getTimestamp

setTimestamp

updateType

getUpdateType

setUpdateType

clientTimeZone

getClientTimeZone

setClientTimeZone

originEventId

getOriginEventId

setOriginEventId

studyBurstId

getStudyBurstId

setStudyBurstId

periodFromOrigin

getPeriodFromOrigin

setPeriodFromOrigin

recordCount

getRecordCount

setRecordCount

getCreatedOn

getType

equals

hashCode

toString