SurveyRule (REST Client 0.25.28 API)

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

```
@Generated(value="io.swagger.codegen.languages.JavaClientCodegen",
           date="2023-07-13T01:30:51.265Z")
public class SurveyRule
extends Object
```
An information screen or question may have one or more rules in an array: * Rules are evaluated before the screen is display, and afterward after the user answers a question, or triggers navigation away from the screen through a `next` or `decline to answer` response; * Rules are evaluated against the user's answer to the question (using the `value` property) or against the user's assigned data groups (using the `dataGroups` property); * If a rule matches, the action for that rule should be followed (e.g. showing a different question than the next question in the list, or ending the survey); * Rule actions will specify whether or not further rules in the list should be evaluated (navigation rules end evaluation, while other actions do not); * If a question allows multiple answers to be submitted, the rule expression matches the rule if *any* of the submitted answers match the rule; * If there are no rules, or no rule matches, proceed to the next question in the list. One and only one action should be provided in the rule: `skipTo`, `endSurvey`, `assignDataGroup`, `displayIf`, or `displayOnly`.

Constructor Summary

Constructors
Constructor and Description

SurveyRule()

Constructors
Constructor and Description
`SurveyRule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SurveyRule`	`addDataGroupsItem(String dataGroupsItem)`
`SurveyRule`	`assignDataGroup(String assignDataGroup)`
`SurveyRule`	`dataGroups(List<String> dataGroups)`
`SurveyRule`	`displayIf(Boolean displayIf)`
`SurveyRule`	`displayUnless(Boolean displayUnless)`
`SurveyRule`	`endSurvey(Boolean endSurvey)`
`boolean`	`equals(Object o)`
`String`	`getAssignDataGroup()` If specified, the value is a data group that should be added to the survey taker if the rule expression is true, or removed if the rule expression is false.
`List<String>`	`getDataGroups()` Some operators will test a set of data groups against the user's set of data groups.
`Operator`	`getOperator()` Get operator
`String`	`getSkipTo()` The property will reference an identifier for a question in the survey.
`String`	`getType()` SurveyRule
`String`	`getValue()` The answer submitted by the user to the question.
`int`	`hashCode()`
`Boolean`	`isDisplayIf()` Before rules only. If the rule expression is true, display this question or information screen.
`Boolean`	`isDisplayUnless()` Before rules only. If the rule expression is true, do not display this question or information.
`Boolean`	`isEndSurvey()` If specified, and the rule's expression is true, immediately stop evaluating rules and end the survey.
`SurveyRule`	`operator(Operator operator)`
`void`	`setAssignDataGroup(String assignDataGroup)`
`void`	`setDataGroups(List<String> dataGroups)`
`void`	`setDisplayIf(Boolean displayIf)`
`void`	`setDisplayUnless(Boolean displayUnless)`
`void`	`setEndSurvey(Boolean endSurvey)`
`void`	`setOperator(Operator operator)`
`void`	`setSkipTo(String skipTo)`
`void`	`setValue(String value)`
`SurveyRule`	`skipTo(String skipTo)`
`String`	`toString()`
`SurveyRule`	`value(String value)`

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

- Constructor Detail
  - SurveyRule
```
public SurveyRule()
```
- Method Detail
  - operator
```
public SurveyRule operator(Operator operator)
```
  - getOperator
```
public Operator getOperator()
```
    Get operator
    
    Returns:
    
    operator
  - setOperator
```
public void setOperator(Operator operator)
```
  - value
```
public SurveyRule value(String value)
```
  - getValue
```
public String getValue()
```
    The answer submitted by the user to the question. This value will be tested against the rule expression (the value is always expressed as a string, regardless of the question's data type). For example, a rule with value=\"10\", operator=eq, indicates that the survey rule expression will be true if the user's answer is equal to 10.
    
    Returns:
    
    value
  - setValue
```
public void setValue(String value)
```
  - dataGroups
```
public SurveyRule dataGroups(List<String> dataGroups)
```
  - addDataGroupsItem
```
public SurveyRule addDataGroupsItem(String dataGroupsItem)
```
  - getDataGroups
```
public List<String> getDataGroups()
```
    Some operators will test a set of data groups against the user's set of data groups. The operators `any` and `all` make a comparison of the sets in this property against the user's data groups.
    
    Returns:
    
    dataGroups
  - setDataGroups
```
public void setDataGroups(List<String> dataGroups)
```
  - skipTo
```
public SurveyRule skipTo(String skipTo)
```
  - getSkipTo
```
public String getSkipTo()
```
    The property will reference an identifier for a question in the survey. If specified, and the rule's expression is true, stop evaluating survey rules and display that question next. Progress through the survey should proceed from that question in the list. The target question should be after the current question in the survey.
    
    Returns:
    
    skipTo
  - setSkipTo
```
public void setSkipTo(String skipTo)
```
  - endSurvey
```
public SurveyRule endSurvey(Boolean endSurvey)
```
  - isEndSurvey
```
public Boolean isEndSurvey()
```
    If specified, and the rule's expression is true, immediately stop evaluating rules and end the survey. The users existing answers to the survey should be sent to the server.
    
    Returns:
    
    endSurvey
  - setEndSurvey
```
public void setEndSurvey(Boolean endSurvey)
```
  - displayIf
```
public SurveyRule displayIf(Boolean displayIf)
```
  - isDisplayIf
```
public Boolean isDisplayIf()
```
    **Before rules only.** If the rule expression is true, display this question or information screen.
    
    Returns:
    
    displayIf
  - setDisplayIf
```
public void setDisplayIf(Boolean displayIf)
```
  - displayUnless
```
public SurveyRule displayUnless(Boolean displayUnless)
```
  - isDisplayUnless
```
public Boolean isDisplayUnless()
```
    **Before rules only.** If the rule expression is true, do not display this question or information. Put differently, show the screen unless the expression is true.
    
    Returns:
    
    displayUnless
  - setDisplayUnless
```
public void setDisplayUnless(Boolean displayUnless)
```
  - assignDataGroup
```
public SurveyRule assignDataGroup(String assignDataGroup)
```
  - getAssignDataGroup
```
public String getAssignDataGroup()
```
    If specified, the value is a data group that should be added to the survey taker if the rule expression is true, or removed if the rule expression is false. Survey rules that specify `assignDataGroup` do not end evaluation of rules in the list; the engine should proceed to evaluate and apply the next rule in the list. The changes to the user's data groups should not be applied if the user cancels the survey.
    
    Returns:
    
    assignDataGroup
  - setAssignDataGroup
```
public void setAssignDataGroup(String assignDataGroup)
```
  - getType
```
public String getType()
```
    SurveyRule
    
    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 SurveyRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SurveyRule

Method Detail

operator

getOperator

setOperator

value

getValue

setValue

dataGroups

addDataGroupsItem

getDataGroups

setDataGroups

skipTo

getSkipTo

setSkipTo

endSurvey

isEndSurvey

setEndSurvey

displayIf

isDisplayIf

setDisplayIf

displayUnless

isDisplayUnless

setDisplayUnless

assignDataGroup

getAssignDataGroup

setAssignDataGroup

getType

equals

hashCode

toString