Package org.apache.ofbiz.content.survey

Class SurveyWrapper

java.lang.Object

org.apache.ofbiz.content.survey.SurveyWrapper

Direct Known Subclasses:

ProductStoreSurveyWrapper

public class SurveyWrapper
extends Object

Survey Wrapper - Class to render survey forms

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	SurveyWrapper.SurveyWrapperException

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SurveyWrapper()
	SurveyWrapper(Delegator delegator, String surveyId)
	SurveyWrapper(Delegator delegator, String responseId, String partyId, String surveyId, Map<String,Object> passThru)
	SurveyWrapper(Delegator delegator, String responseId, String partyId, String surveyId, Map<String,Object> passThru, Map<String,Object> defaultValues)

Method Summary

Modifier and Type	Method	Description
void	addToTemplateContext(String name, Object value)	Adds an object to the FTL survey template context
boolean	canRespond()	Can respond boolean.
boolean	canUpdate()	Can update boolean.
protected void	checkParameters()	Check parameters.
long	getNumberResponses()	Gets number responses.
List<GenericValue>	getQuestionResponses(GenericValue question, int startIndex, int number)	Gets question responses.
Map<String,Object>	getResponseAnswers(String responseId)	returns a Map of answers keyed on SurveyQuestion ID from the most current SurveyResponse ID
Map<String,Object>	getResultInfo(GenericValue question)	Gets result info.
Map<String,Object>	getResults(List<GenericValue> questions)	Gets results.
GenericValue	getSurvey()	returns the GenericValue object for the current Survey
String	getSurveyName()	Gets survey name.
List<GenericValue>	getSurveyQuestionAndAppls()	returns a list of SurveyQuestions (in order by sequence number) for the current Survey
List<GenericValue>	getSurveyResponses(GenericValue question)	Gets survey responses.
protected freemarker.template.Template	getTemplate(URL templateUrl)	Gets template.
protected String	getThisResponseId()	returns the most current SurveyResponse ID for a survey; null if no party is found
void	removeFromTemplateContext(String name)	Removes an object from the FTL survey template context
Writer	render(String templatePath)	Renders the Survey
void	render(URL templateUrl, Writer writer)	Renders the Survey
void	setDefaultValues(Map<String,Object> defaultValues)	Sets the default values
void	setDelegator(Delegator delegator)	Sets delegator.
void	setEdit(boolean edit)	Sets edit.
void	setPartyId(String partyId)	Sets party id.
void	setPassThru(Map<String,Object> passThru)	Sets the pass-thru values (hidden form fields)
void	setSurveyId(String surveyId)	Sets survey id.
protected void	setThisResponseId(String responseId)	Sets this response id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SurveyWrapper

protected SurveyWrapper()

SurveyWrapper

public SurveyWrapper(Delegator delegator,
 String responseId,
 String partyId,
 String surveyId,
 Map<String,Object> passThru,
 Map<String,Object> defaultValues)

SurveyWrapper

public SurveyWrapper(Delegator delegator,
 String responseId,
 String partyId,
 String surveyId,
 Map<String,Object> passThru)

SurveyWrapper

public SurveyWrapper(Delegator delegator,
 String surveyId)

Method Details

setDelegator

public void setDelegator(Delegator delegator)

Sets delegator.

Parameters:

delegator - the delegator

setPartyId

public void setPartyId(String partyId)

Sets party id.

Parameters:

partyId - the party id

setSurveyId

public void setSurveyId(String surveyId)

Sets survey id.

Parameters:

surveyId - the survey id

checkParameters

protected void checkParameters()

Check parameters.

setPassThru

public void setPassThru(Map<String,Object> passThru)

Sets the pass-thru values (hidden form fields)

Parameters:

passThru -

setDefaultValues

public void setDefaultValues(Map<String,Object> defaultValues)

Sets the default values

Parameters:

defaultValues -

addToTemplateContext

public void addToTemplateContext(String name,
 Object value)

Adds an object to the FTL survey template context

Parameters:

name -

value -

removeFromTemplateContext

public void removeFromTemplateContext(String name)

Removes an object from the FTL survey template context

Parameters:

name -

render

public Writer render(String templatePath)
              throws SurveyWrapper.SurveyWrapperException

Renders the Survey

Returns:

Writer object from the parsed Freemarker Template

Throws:

SurveyWrapper.SurveyWrapperException

render

public void render(URL templateUrl,
 Writer writer)
            throws SurveyWrapper.SurveyWrapperException

Renders the Survey

Parameters:

templateUrl - the template URL

writer - the write

Throws:

SurveyWrapper.SurveyWrapperException

getTemplate

protected freemarker.template.Template getTemplate(URL templateUrl)

Gets template.

Parameters:

templateUrl - the template url

Returns:

the template

setEdit

public void setEdit(boolean edit)

Sets edit.

Parameters:

edit - the edit

getSurvey

public GenericValue getSurvey()

returns the GenericValue object for the current Survey

getSurveyName

public String getSurveyName()

Gets survey name.

Returns:

the survey name

canUpdate

public boolean canUpdate()

Can update boolean.

Returns:

the boolean

canRespond

public boolean canRespond()

Can respond boolean.

Returns:

the boolean

getSurveyQuestionAndAppls

public List<GenericValue> getSurveyQuestionAndAppls()

returns a list of SurveyQuestions (in order by sequence number) for the current Survey

getThisResponseId

protected String getThisResponseId()

returns the most current SurveyResponse ID for a survey; null if no party is found

setThisResponseId

protected void setThisResponseId(String responseId)

Sets this response id.

Parameters:

responseId - the response id

getNumberResponses

public long getNumberResponses()
                        throws SurveyWrapper.SurveyWrapperException

Gets number responses.

Returns:

the number responses

Throws:

SurveyWrapper.SurveyWrapperException - the survey wrapper exception

getSurveyResponses

public List<GenericValue> getSurveyResponses(GenericValue question)
                                      throws SurveyWrapper.SurveyWrapperException

Gets survey responses.

Parameters:

question - the question

Returns:

the survey responses

Throws:

SurveyWrapper.SurveyWrapperException - the survey wrapper exception

getResponseAnswers

public Map<String,Object> getResponseAnswers(String responseId)
                                      throws SurveyWrapper.SurveyWrapperException

returns a Map of answers keyed on SurveyQuestion ID from the most current SurveyResponse ID

Throws:

SurveyWrapper.SurveyWrapperException

getQuestionResponses

public List<GenericValue> getQuestionResponses(GenericValue question,
 int startIndex,
 int number)
                                        throws SurveyWrapper.SurveyWrapperException

Gets question responses.

Parameters:

question - the question

startIndex - the start index

number - the number

Returns:

the question responses

Throws:

SurveyWrapper.SurveyWrapperException - the survey wrapper exception

getResults

public Map<String,Object> getResults(List<GenericValue> questions)
                              throws SurveyWrapper.SurveyWrapperException

Gets results.

Parameters:

questions - the questions

Returns:

the results

Throws:

SurveyWrapper.SurveyWrapperException - the survey wrapper exception

getResultInfo

public Map<String,Object> getResultInfo(GenericValue question)
                                 throws SurveyWrapper.SurveyWrapperException

Gets result info.

Parameters:

question - the question

Returns:

the result info

Throws:

SurveyWrapper.SurveyWrapperException - the survey wrapper exception