SurveyQuestion (com.blockchyp:blockchyp-java 1.24.13 API)

java.lang.Object
- com.blockchyp.client.dto.SurveyQuestion

All Implemented Interfaces:: IAbstractAcknowledgement, ITimeoutRequest

public class SurveyQuestion
extends Object
implements ITimeoutRequest, IAbstractAcknowledgement

Models a survey question.

Constructor Summary

Constructors
Constructor and Description

SurveyQuestion()

Constructors
Constructor and Description
`SurveyQuestion()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addResponse(SurveyDataPoint value)` Adds a the set of response data points.
`String`	`getError()` Gets the error, if an error occurred.
`String`	`getId()` Gets internal id for a survey question.
`int`	`getOrdinal()` Gets ordinal number indicating the position of the survey question in the post transaction sequence.
`String`	`getQuestionText()` Gets the full text of the transaction.
`String`	`getQuestionType()` Gets the type of question.
`int`	`getResponseCount()` Gets the total number of responses during the query period if results are requested.
`String`	`getResponseDescription()` Gets a narrative description of the transaction result.
`float`	`getResponseRate()` Gets the response rate, expressed as a ratio, if results are requested.
`Collection<SurveyDataPoint>`	`getResponses()` Gets the set of response data points.
`int`	`getTimeout()` Gets the request timeout in seconds.
`int`	`getTransactionCount()` Gets the total number of transactions processed during the query period if results are requested.
`boolean`	`isEnabled()` Gets determines whether or not the question will be presented post transaction.
`boolean`	`isSuccess()` Gets whether or not the request succeeded.
`boolean`	`isTest()` Gets whether or not to route transaction to the test gateway.
`void`	`setEnabled(boolean value)` Sets determines whether or not the question will be presented post transaction.
`void`	`setError(String value)` Sets the error, if an error occurred.
`void`	`setId(String value)` Sets internal id for a survey question.
`void`	`setOrdinal(int value)` Sets ordinal number indicating the position of the survey question in the post transaction sequence.
`void`	`setQuestionText(String value)` Sets the full text of the transaction.
`void`	`setQuestionType(String value)` Sets the type of question.
`void`	`setResponseCount(int value)` Sets the total number of responses during the query period if results are requested.
`void`	`setResponseDescription(String value)` Sets a narrative description of the transaction result.
`void`	`setResponseRate(float value)` Sets the response rate, expressed as a ratio, if results are requested.
`void`	`setResponses(Collection<SurveyDataPoint> value)` Sets the set of response data points.
`void`	`setSuccess(boolean value)` Sets whether or not the request succeeded.
`void`	`setTest(boolean value)` Sets whether or not to route transaction to the test gateway.
`void`	`setTimeout(int value)` Sets the request timeout in seconds.
`void`	`setTransactionCount(int value)` Sets the total number of transactions processed during the query period if results are requested.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SurveyQuestion
```
public SurveyQuestion()
```
- Method Detail
  - setTimeout
```
public void setTimeout(int value)
```
    Sets the request timeout in seconds.
    
    Parameters:
    
    value - the request timeout in seconds.
  - getTimeout
```
public int getTimeout()
```
    Gets the request timeout in seconds.
    
    Specified by:
    
    getTimeout in interface ITimeoutRequest
    
    Returns:
    
    the request timeout in seconds.
  - setTest
```
public void setTest(boolean value)
```
    Sets whether or not to route transaction to the test gateway.
    
    Parameters:
    
    value - whether or not to route transaction to the test gateway.
  - isTest
```
public boolean isTest()
```
    Gets whether or not to route transaction to the test gateway.
    
    Specified by:
    
    isTest in interface ITimeoutRequest
    
    Returns:
    
    whether or not to route transaction to the test gateway.
  - setSuccess
```
public void setSuccess(boolean value)
```
    Sets whether or not the request succeeded.
    
    Parameters:
    
    value - whether or not the request succeeded.
  - isSuccess
```
public boolean isSuccess()
```
    Gets whether or not the request succeeded.
    
    Specified by:
    
    isSuccess in interface IAbstractAcknowledgement
    
    Returns:
    
    whether or not the request succeeded.
  - setError
```
public void setError(String value)
```
    Sets the error, if an error occurred.
    
    Parameters:
    
    value - the error, if an error occurred.
  - getError
```
public String getError()
```
    Gets the error, if an error occurred.
    
    Specified by:
    
    getError in interface IAbstractAcknowledgement
    
    Returns:
    
    the error, if an error occurred.
  - setResponseDescription
```
public void setResponseDescription(String value)
```
    Sets a narrative description of the transaction result.
    
    Parameters:
    
    value - a narrative description of the transaction result.
  - getResponseDescription
```
public String getResponseDescription()
```
    Gets a narrative description of the transaction result.
    
    Specified by:
    
    getResponseDescription in interface IAbstractAcknowledgement
    
    Returns:
    
    a narrative description of the transaction result.
  - setId
```
public void setId(String value)
```
    Sets internal id for a survey question.
    
    Parameters:
    
    value - internal id for a survey question.
  - getId
```
public String getId()
```
    Gets internal id for a survey question.
    
    Returns:
    
    internal id for a survey question.
  - setOrdinal
```
public void setOrdinal(int value)
```
    Sets ordinal number indicating the position of the survey question in the post transaction sequence.
    
    Parameters:
    
    value - ordinal number indicating the position of the survey question in the post transaction sequence.
  - getOrdinal
```
public int getOrdinal()
```
    Gets ordinal number indicating the position of the survey question in the post transaction sequence.
    
    Returns:
    
    ordinal number indicating the position of the survey question in the post transaction sequence.
  - setEnabled
```
public void setEnabled(boolean value)
```
    Sets determines whether or not the question will be presented post transaction.
    
    Parameters:
    
    value - determines whether or not the question will be presented post transaction.
  - isEnabled
```
public boolean isEnabled()
```
    Gets determines whether or not the question will be presented post transaction.
    
    Returns:
    
    determines whether or not the question will be presented post transaction.
  - setQuestionText
```
public void setQuestionText(String value)
```
    Sets the full text of the transaction.
    
    Parameters:
    
    value - the full text of the transaction.
  - getQuestionText
```
public String getQuestionText()
```
    Gets the full text of the transaction.
    
    Returns:
    
    the full text of the transaction.
  - setQuestionType
```
public void setQuestionType(String value)
```
    Sets the type of question.
    
    Parameters:
    
    value - the type of question. Valid values are 'yes_no' and 'scaled'.
  - getQuestionType
```
public String getQuestionType()
```
    Gets the type of question.
    
    Returns:
    
    the type of question. Valid values are 'yes_no' and 'scaled'.
  - setTransactionCount
```
public void setTransactionCount(int value)
```
    Sets the total number of transactions processed during the query period if results are requested.
    
    Parameters:
    
    value - the total number of transactions processed during the query period if results are requested.
  - getTransactionCount
```
public int getTransactionCount()
```
    Gets the total number of transactions processed during the query period if results are requested.
    
    Returns:
    
    the total number of transactions processed during the query period if results are requested.
  - setResponseCount
```
public void setResponseCount(int value)
```
    Sets the total number of responses during the query period if results are requested.
    
    Parameters:
    
    value - the total number of responses during the query period if results are requested.
  - getResponseCount
```
public int getResponseCount()
```
    Gets the total number of responses during the query period if results are requested.
    
    Returns:
    
    the total number of responses during the query period if results are requested.
  - setResponseRate
```
public void setResponseRate(float value)
```
    Sets the response rate, expressed as a ratio, if results are requested.
    
    Parameters:
    
    value - the response rate, expressed as a ratio, if results are requested.
  - getResponseRate
```
public float getResponseRate()
```
    Gets the response rate, expressed as a ratio, if results are requested.
    
    Returns:
    
    the response rate, expressed as a ratio, if results are requested.
  - setResponses
```
public void setResponses(Collection<SurveyDataPoint> value)
```
    Sets the set of response data points.
    
    Parameters:
    
    value - the set of response data points.
  - getResponses
```
public Collection<SurveyDataPoint> getResponses()
```
    Gets the set of response data points.
    
    Returns:
    
    the set of response data points.
  - addResponse
```
public void addResponse(SurveyDataPoint value)
```
    Adds a the set of response data points.
    
    Parameters:
    
    value - the set of response data points.

Class SurveyQuestion

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SurveyQuestion

Method Detail

setTimeout

getTimeout

setTest

isTest

setSuccess

isSuccess

setError

getError

setResponseDescription

getResponseDescription

setId

getId

setOrdinal

getOrdinal

setEnabled

isEnabled

setQuestionText

getQuestionText

setQuestionType

getQuestionType

setTransactionCount

getTransactionCount

setResponseCount

getResponseCount

setResponseRate

getResponseRate

setResponses

getResponses

addResponse