Package org.ametys.plugins.survey.data
Class SurveySession
java.lang.Object
org.ametys.plugins.survey.data.SurveySession
- Direct Known Subclasses:
ProcessInputAction.SurveyInput
Class representing a survey session, i.e. all the responses of a user to a survey.
-
Field Summary
Modifier and TypeFieldDescriptionprotected List<SurveyAnswer>
The list of answers.protected int
The session ID.protected String
The IP address of the person who answered the survey.protected String
The login of the person who answered the survey.protected String
The population of the person who answered the survey.protected Date
The date and time at which the person completed the survey.protected String
The survey ID. -
Constructor Summary
ConstructorDescriptionBuild a SurveySession object.SurveySession
(int id, String surveyId, UserIdentity user, String ipAddress, Date submittedAt, List<SurveyAnswer> answers) Build a SurveySession object. -
Method Summary
Modifier and TypeMethodDescriptionList<? extends SurveyAnswer>
Get the answers.int
getId()
Get the id.Get the ipAddress.getLogin()
Get the login of the user answering the surveyGet the population of the user answering the surveyGet the submittedAt.Get the surveyId.getUser()
Get the identity of the user answering the surveyvoid
setAnswers
(List<SurveyAnswer> answers) Set the answers.void
setId
(int id) Set the id.void
setIpAddress
(String ipAddress) Set the ipAddress.void
Set the login of the user answering the surveyvoid
setPopulation
(String population) Set the population of the user answering the surveyvoid
setSubmittedAt
(Date submittedAt) Set the submittedAt.void
setSurveyId
(String surveyId) Set the surveyId.void
setUser
(UserIdentity user) Set the identity of the user answering the survey
-
Field Details
-
_id
The session ID. -
_surveyId
The survey ID. -
_login
The login of the person who answered the survey. -
_population
The population of the person who answered the survey. -
_ipAddress
The IP address of the person who answered the survey. -
_submittedAt
The date and time at which the person completed the survey. -
_answers
The list of answers.
-
-
Constructor Details
-
SurveySession
public SurveySession()Build a SurveySession object. -
SurveySession
public SurveySession(int id, String surveyId, UserIdentity user, String ipAddress, Date submittedAt, List<SurveyAnswer> answers) Build a SurveySession object.- Parameters:
id
- the session ID.surveyId
- the survey ID.user
- the user.ipAddress
- the user IP address.submittedAt
- the date of completion.answers
- the list of answers.
-
-
Method Details
-
getId
Get the id.- Returns:
- the id
-
setId
Set the id.- Parameters:
id
- the id to set
-
getSurveyId
Get the surveyId.- Returns:
- the surveyId
-
setSurveyId
Set the surveyId.- Parameters:
surveyId
- the surveyId to set
-
getLogin
Get the login of the user answering the survey- Returns:
- the user login
-
setLogin
Set the login of the user answering the survey- Parameters:
login
- the login
-
getPopulation
Get the population of the user answering the survey- Returns:
- the user identity
-
setPopulation
Set the population of the user answering the survey- Parameters:
population
- the population
-
setUser
Set the identity of the user answering the survey- Parameters:
user
- the user identity
-
getUser
Get the identity of the user answering the survey- Returns:
- the user identity
-
getIpAddress
Get the ipAddress.- Returns:
- the ipAddress
-
setIpAddress
Set the ipAddress.- Parameters:
ipAddress
- the ipAddress to set
-
getSubmittedAt
Get the submittedAt.- Returns:
- the submittedAt
-
setSubmittedAt
Set the submittedAt.- Parameters:
submittedAt
- the submittedAt to set
-
getAnswers
Get the answers.- Returns:
- the answers
-
setAnswers
Set the answers.- Parameters:
answers
- the answers to set
-