Package com.mypurecloud.sdk.v2.model

Class Survey

java.lang.Object

com.mypurecloud.sdk.v2.model.Survey

All Implemented Interfaces:

Serializable

public class Survey
extends Object
implements Serializable

Survey

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Survey.StatusEnum	Gets or Sets status
static enum	Survey.SurveyTypeEnum	Type of the survey

Constructor Summary

Constructors

Constructor	Description
Survey()
Survey(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
Survey	agent(DomainEntityRef agent)
Survey	agentTeam(Team agentTeam)	The team that the agent belongs to
Survey	answers(SurveyScoringSet answers)
Survey	completedDate(Date completedDate)	Date time is represented as an ISO-8601 string.
Survey	conversation(ConversationReference conversation)
boolean	equals(Object o)
Survey	flow(AddressableEntityRef flow)	An Architect flow that executed in order to collect the answers for this survey.
DomainEntityRef	getAgent()
Team	getAgentTeam()
SurveyScoringSet	getAnswers()
Date	getCompletedDate()
ConversationReference	getConversation()
AddressableEntityRef	getFlow()
String	getId()
Boolean	getMissingRequiredAnswer()
String	getName()
QueueReference	getQueue()
String	getSelfUri()
Survey.StatusEnum	getStatus()
SurveyErrorDetails	getSurveyErrorDetails()
SurveyForm	getSurveyForm()
Survey.SurveyTypeEnum	getSurveyType()
int	hashCode()
Survey	missingRequiredAnswer(Boolean missingRequiredAnswer)	True if any of the required questions for the survey form have not been answered.
Survey	name(String name)
Survey	queue(QueueReference queue)
void	setAgent(DomainEntityRef agent)
void	setAgentTeam(Team agentTeam)
void	setAnswers(SurveyScoringSet answers)
void	setCompletedDate(Date completedDate)
void	setConversation(ConversationReference conversation)
void	setFlow(AddressableEntityRef flow)
void	setMissingRequiredAnswer(Boolean missingRequiredAnswer)
void	setName(String name)
void	setQueue(QueueReference queue)
void	setStatus(Survey.StatusEnum status)
void	setSurveyErrorDetails(SurveyErrorDetails surveyErrorDetails)
void	setSurveyForm(SurveyForm surveyForm)
void	setSurveyType(Survey.SurveyTypeEnum surveyType)
Survey	status(Survey.StatusEnum status)
Survey	surveyErrorDetails(SurveyErrorDetails surveyErrorDetails)	Additional information about what happened when the survey is in Error status.
Survey	surveyForm(SurveyForm surveyForm)	Survey form used for this survey.
Survey	surveyType(Survey.SurveyTypeEnum surveyType)	Type of the survey
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Survey

public Survey()

Survey

public Survey(Boolean initWithEmptyList)

Method Details

getId

public String getId()

name

public Survey name(String name)

getName

public String getName()

setName

public void setName(String name)

conversation

public Survey conversation(ConversationReference conversation)

getConversation

public ConversationReference getConversation()

setConversation

public void setConversation(ConversationReference conversation)

surveyForm

public Survey surveyForm(SurveyForm surveyForm)

Survey form used for this survey.

getSurveyForm

public SurveyForm getSurveyForm()

setSurveyForm

public void setSurveyForm(SurveyForm surveyForm)

agent

public Survey agent(DomainEntityRef agent)

getAgent

public DomainEntityRef getAgent()

setAgent

public void setAgent(DomainEntityRef agent)

status

public Survey status(Survey.StatusEnum status)

getStatus

public Survey.StatusEnum getStatus()

setStatus

public void setStatus(Survey.StatusEnum status)

queue

public Survey queue(QueueReference queue)

getQueue

public QueueReference getQueue()

setQueue

public void setQueue(QueueReference queue)

answers

public Survey answers(SurveyScoringSet answers)

getAnswers

public SurveyScoringSet getAnswers()

setAnswers

public void setAnswers(SurveyScoringSet answers)

completedDate

public Survey completedDate(Date completedDate)

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z

getCompletedDate

public Date getCompletedDate()

setCompletedDate

public void setCompletedDate(Date completedDate)

surveyErrorDetails

public Survey surveyErrorDetails(SurveyErrorDetails surveyErrorDetails)

Additional information about what happened when the survey is in Error status.

getSurveyErrorDetails

public SurveyErrorDetails getSurveyErrorDetails()

setSurveyErrorDetails

public void setSurveyErrorDetails(SurveyErrorDetails surveyErrorDetails)

agentTeam

public Survey agentTeam(Team agentTeam)

The team that the agent belongs to

getAgentTeam

public Team getAgentTeam()

setAgentTeam

public void setAgentTeam(Team agentTeam)

surveyType

public Survey surveyType(Survey.SurveyTypeEnum surveyType)

Type of the survey

getSurveyType

public Survey.SurveyTypeEnum getSurveyType()

setSurveyType

public void setSurveyType(Survey.SurveyTypeEnum surveyType)

missingRequiredAnswer

public Survey missingRequiredAnswer(Boolean missingRequiredAnswer)

True if any of the required questions for the survey form have not been answered. Null if survey is not finished.

getMissingRequiredAnswer

public Boolean getMissingRequiredAnswer()

setMissingRequiredAnswer

public void setMissingRequiredAnswer(Boolean missingRequiredAnswer)

flow

public Survey flow(AddressableEntityRef flow)

An Architect flow that executed in order to collect the answers for this survey.

getFlow

public AddressableEntityRef getFlow()

setFlow

public void setFlow(AddressableEntityRef flow)

getSelfUri

public String getSelfUri()

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