org.ofbiz.content.survey
Class SurveyWrapper

java.lang.Object
  org.ofbiz.content.survey.SurveyWrapper

Direct Known Subclasses:

ProductStoreSurveyWrapper

public class SurveyWrapper
extends java.lang.Object

Survey Wrapper - Class to render survey forms

Nested Class Summary

protected class

SurveyWrapper.SurveyWrapperException

Field Summary

protected java.util.Map<java.lang.String,java.lang.Object>	defaultValues
protected Delegator	delegator
protected boolean	edit
static java.lang.String	module
protected java.lang.String	partyId
protected java.util.Map<java.lang.String,java.lang.Object>	passThru
protected java.lang.String	responseId
protected java.lang.String	surveyId
protected java.util.Map<java.lang.String,java.lang.Object>	templateContext

Constructor Summary

protected	SurveyWrapper()
	SurveyWrapper(Delegator delegator, java.lang.String surveyId)
	SurveyWrapper(Delegator delegator, java.lang.String responseId, java.lang.String partyId, java.lang.String surveyId, java.util.Map<java.lang.String,java.lang.Object> passThru)
	SurveyWrapper(Delegator delegator, java.lang.String responseId, java.lang.String partyId, java.lang.String surveyId, java.util.Map<java.lang.String,java.lang.Object> passThru, java.util.Map<java.lang.String,java.lang.Object> defaultValues)

Method Summary

void	addToTemplateContext(java.lang.String name, java.lang.Object value) Adds an object to the FTL survey template context
boolean	canRespond()
boolean	canUpdate()
protected void	checkParameters()
long	getNumberResponses()
java.util.List<GenericValue>	getQuestionResponses(GenericValue question, int startIndex, int number)
java.util.Map<java.lang.String,java.lang.Object>	getResponseAnswers(java.lang.String responseId)
java.util.Map<java.lang.String,java.lang.Object>	getResultInfo(GenericValue question)
java.util.Map<java.lang.String,java.lang.Object>	getResults(java.util.List<GenericValue> questions)
GenericValue	getSurvey()
java.lang.String	getSurveyName()
java.util.List<GenericValue>	getSurveyQuestionAndAppls()
java.util.List<GenericValue>	getSurveyResponses(GenericValue question)
protected freemarker.template.Template	getTemplate(java.net.URL templateUrl)
protected java.lang.String	getThisResponseId()
void	removeFromTemplateContext(java.lang.String name) Removes an object from the FTL survey template context
java.io.Writer	render(java.lang.String templatePath) Renders the Survey
void	render(java.net.URL templateUrl, java.io.Writer writer) Renders the Survey
void	setDefaultValues(java.util.Map<java.lang.String,java.lang.Object> defaultValues) Sets the default values
void	setEdit(boolean edit)
void	setPassThru(java.util.Map<java.lang.String,java.lang.Object> passThru) Sets the pass-thru values (hidden form fields)
protected void	setThisResponseId(java.lang.String responseId)

Methods inherited from class java.lang.Object

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

Field Detail

module

public static final java.lang.String module

delegator

protected Delegator delegator

responseId

protected java.lang.String responseId

partyId

protected java.lang.String partyId

surveyId

protected java.lang.String surveyId

templateContext

protected java.util.Map<java.lang.String,java.lang.Object> templateContext

passThru

protected java.util.Map<java.lang.String,java.lang.Object> passThru

defaultValues

protected java.util.Map<java.lang.String,java.lang.Object> defaultValues

edit

protected boolean edit

Constructor Detail

SurveyWrapper

protected SurveyWrapper()

SurveyWrapper

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

SurveyWrapper

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

SurveyWrapper

public SurveyWrapper(Delegator delegator,
                     java.lang.String surveyId)

Method Detail

checkParameters

protected void checkParameters()

setPassThru

public void setPassThru(java.util.Map<java.lang.String,java.lang.Object> passThru)

Sets the pass-thru values (hidden form fields)

Parameters:

passThru -

setDefaultValues

public void setDefaultValues(java.util.Map<java.lang.String,java.lang.Object> defaultValues)

Sets the default values

Parameters:

defaultValues -

addToTemplateContext

public void addToTemplateContext(java.lang.String name,
                                 java.lang.Object value)

Adds an object to the FTL survey template context

Parameters:

name -

value -

removeFromTemplateContext

public void removeFromTemplateContext(java.lang.String name)

Removes an object from the FTL survey template context

Parameters:

name -

render

public java.io.Writer render(java.lang.String templatePath)
                      throws SurveyWrapper.SurveyWrapperException

Renders the Survey

Returns:

Writer object from the parsed Freemarker Template

Throws:

SurveyWrapper.SurveyWrapperException

render

public void render(java.net.URL templateUrl,
                   java.io.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(java.net.URL templateUrl)

setEdit

public void setEdit(boolean edit)

getSurvey

public GenericValue getSurvey()

getSurveyName

public java.lang.String getSurveyName()

canUpdate

public boolean canUpdate()

canRespond

public boolean canRespond()

getSurveyQuestionAndAppls

public java.util.List<GenericValue> getSurveyQuestionAndAppls()

getThisResponseId

protected java.lang.String getThisResponseId()

setThisResponseId

protected void setThisResponseId(java.lang.String responseId)

getNumberResponses

public long getNumberResponses()
                        throws SurveyWrapper.SurveyWrapperException

Throws:

SurveyWrapper.SurveyWrapperException

getSurveyResponses

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

Throws:

SurveyWrapper.SurveyWrapperException

getResponseAnswers

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

Throws:

SurveyWrapper.SurveyWrapperException

getQuestionResponses

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

Throws:

SurveyWrapper.SurveyWrapperException

getResults

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

Throws:

SurveyWrapper.SurveyWrapperException

getResultInfo

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

Throws:

SurveyWrapper.SurveyWrapperException