Package com.blockchyp.client.dto
Class SurveyQuestion
java.lang.Object
com.blockchyp.client.dto.SurveyQuestion
- All Implemented Interfaces:
IAbstractAcknowledgement,ITimeoutRequest
Models a survey question.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddResponse(SurveyDataPoint value) Adds a the set of response data points.getError()Gets the error, if an error occurred.getId()Gets internal id for a survey question.intGets ordinal number indicating the position of the survey question in the post transaction sequence.Gets the full text of the transaction.Gets the type of question.intGets the total number of responses during the query period if results are requested.Gets a narrative description of the transaction result.floatGets the response rate, expressed as a ratio, if results are requested.Gets the set of response data points.intGets the request timeout in seconds.intGets the total number of transactions processed during the query period if results are requested.booleanGets determines whether or not the question will be presented post transaction.booleanGets whether or not the request succeeded.booleanisTest()Gets whether or not to route transaction to the test gateway.voidsetEnabled(boolean value) Sets determines whether or not the question will be presented post transaction.voidSets the error, if an error occurred.voidSets internal id for a survey question.voidsetOrdinal(int value) Sets ordinal number indicating the position of the survey question in the post transaction sequence.voidsetQuestionText(String value) Sets the full text of the transaction.voidsetQuestionType(String value) Sets the type of question.voidsetResponseCount(int value) Sets the total number of responses during the query period if results are requested.voidsetResponseDescription(String value) Sets a narrative description of the transaction result.voidsetResponseRate(float value) Sets the response rate, expressed as a ratio, if results are requested.voidsetResponses(Collection<SurveyDataPoint> value) Sets the set of response data points.voidsetSuccess(boolean value) Sets whether or not the request succeeded.voidsetTest(boolean value) Sets whether or not to route transaction to the test gateway.voidsetTimeout(int value) Sets the request timeout in seconds.voidsetTransactionCount(int value) Sets the total number of transactions processed during the query period if results are requested.
-
Constructor Details
-
SurveyQuestion
public SurveyQuestion()
-
-
Method Details
-
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:
getTimeoutin interfaceITimeoutRequest- 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:
isTestin interfaceITimeoutRequest- 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:
isSuccessin interfaceIAbstractAcknowledgement- Returns:
- whether or not the request succeeded.
-
setError
Sets the error, if an error occurred.- Parameters:
value- the error, if an error occurred.
-
getError
Gets the error, if an error occurred.- Specified by:
getErrorin interfaceIAbstractAcknowledgement- Returns:
- the error, if an error occurred.
-
setResponseDescription
Sets a narrative description of the transaction result.- Parameters:
value- a narrative description of the transaction result.
-
getResponseDescription
Gets a narrative description of the transaction result.- Specified by:
getResponseDescriptionin interfaceIAbstractAcknowledgement- Returns:
- a narrative description of the transaction result.
-
setId
Sets internal id for a survey question.- Parameters:
value- internal id for a survey question.
-
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
Sets the full text of the transaction.- Parameters:
value- the full text of the transaction.
-
getQuestionText
Gets the full text of the transaction.- Returns:
- the full text of the transaction.
-
setQuestionType
Sets the type of question.- Parameters:
value- the type of question. Valid values are 'yes_no' and 'scaled'.
-
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
Sets the set of response data points.- Parameters:
value- the set of response data points.
-
getResponses
Gets the set of response data points.- Returns:
- the set of response data points.
-
addResponse
Adds a the set of response data points.- Parameters:
value- the set of response data points.
-